From 5122f5f91ced24a502e4dc7ada9fff875825f337 Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Thu, 29 Aug 2024 19:10:23 +0000 Subject: [PATCH] Update models for release --- .changes/3.321.1 | 32 +++++++++++ CHANGELOG.md | 9 ++++ src/Personalize/PersonalizeClient.php | 2 + .../2023-07-26/api-2.json | 5 +- .../2023-07-26/api-2.json.php | 2 +- .../2023-07-26/docs-2.json | 2 +- .../2023-07-26/docs-2.json.php | 2 +- .../bedrock-runtime/2023-09-30/api-2.json | 5 +- .../bedrock-runtime/2023-09-30/api-2.json.php | 2 +- .../bedrock-runtime/2023-09-30/docs-2.json | 10 ++-- .../2023-09-30/docs-2.json.php | 2 +- src/data/personalize/2018-05-22/api-2.json | 54 ++++++++++++++++++- .../personalize/2018-05-22/api-2.json.php | 2 +- src/data/personalize/2018-05-22/docs-2.json | 51 ++++++++++++++---- .../personalize/2018-05-22/docs-2.json.php | 2 +- src/data/quicksight/2018-04-01/api-2.json | 11 +++- src/data/quicksight/2018-04-01/api-2.json.php | 2 +- src/data/quicksight/2018-04-01/docs-2.json | 7 ++- .../quicksight/2018-04-01/docs-2.json.php | 2 +- src/data/states/2016-11-23/api-2.json | 21 ++++++-- src/data/states/2016-11-23/api-2.json.php | 2 +- src/data/states/2016-11-23/docs-2.json | 15 +++++- src/data/states/2016-11-23/docs-2.json.php | 2 +- src/data/wafv2/2019-07-29/api-2.json | 2 +- src/data/wafv2/2019-07-29/api-2.json.php | 2 +- src/data/wafv2/2019-07-29/docs-2.json | 2 +- src/data/wafv2/2019-07-29/docs-2.json.php | 2 +- 27 files changed, 210 insertions(+), 42 deletions(-) create mode 100644 .changes/3.321.1 diff --git a/.changes/3.321.1 b/.changes/3.321.1 new file mode 100644 index 0000000000..161e7fe778 --- /dev/null +++ b/.changes/3.321.1 @@ -0,0 +1,32 @@ +[ + { + "type": "api-change", + "category": "BedrockRuntime", + "description": "Add support for imported-model in invokeModel and InvokeModelWithResponseStream." + }, + { + "type": "api-change", + "category": "QuickSight", + "description": "Increased Character Limit for Dataset Calculation Field expressions" + }, + { + "type": "api-change", + "category": "WAFV2", + "description": "The minimum request rate for a rate-based rule is now 10. Before this, it was 100." + }, + { + "type": "api-change", + "category": "SFN", + "description": "This release adds support for static analysis to ValidateStateMachineDefinition API, which can now return optional WARNING diagnostics for semantic errors on the definition of an Amazon States Language (ASL) state machine." + }, + { + "type": "api-change", + "category": "Personalize", + "description": "This releases ability to update automatic training scheduler for customer solutions" + }, + { + "type": "api-change", + "category": "BedrockAgentRuntime", + "description": "Lifting the maximum length on Bedrock KnowledgeBase RetrievalFilter array" + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fbbd0a951..b8d2035a67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # CHANGELOG +## next release + +* `Aws\BedrockRuntime` - Add support for imported-model in invokeModel and InvokeModelWithResponseStream. +* `Aws\QuickSight` - Increased Character Limit for Dataset Calculation Field expressions +* `Aws\WAFV2` - The minimum request rate for a rate-based rule is now 10. Before this, it was 100. +* `Aws\SFN` - This release adds support for static analysis to ValidateStateMachineDefinition API, which can now return optional WARNING diagnostics for semantic errors on the definition of an Amazon States Language (ASL) state machine. +* `Aws\Personalize` - This releases ability to update automatic training scheduler for customer solutions +* `Aws\BedrockAgentRuntime` - Lifting the maximum length on Bedrock KnowledgeBase RetrievalFilter array + ## 3.321.0 - 2024-08-28 * `Aws\DataZone` - Update regex to include dot character to be consistent with IAM role creation in the authorized principal field for create and update subscription target. diff --git a/src/Personalize/PersonalizeClient.php b/src/Personalize/PersonalizeClient.php index af5148f793..08febe45c9 100644 --- a/src/Personalize/PersonalizeClient.php +++ b/src/Personalize/PersonalizeClient.php @@ -145,5 +145,7 @@ * @method \GuzzleHttp\Promise\Promise updateMetricAttributionAsync(array $args = []) * @method \Aws\Result updateRecommender(array $args = []) * @method \GuzzleHttp\Promise\Promise updateRecommenderAsync(array $args = []) + * @method \Aws\Result updateSolution(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateSolutionAsync(array $args = []) */ class PersonalizeClient extends AwsClient {} diff --git a/src/data/bedrock-agent-runtime/2023-07-26/api-2.json b/src/data/bedrock-agent-runtime/2023-07-26/api-2.json index c58c1414ff..821152e72a 100644 --- a/src/data/bedrock-agent-runtime/2023-07-26/api-2.json +++ b/src/data/bedrock-agent-runtime/2023-07-26/api-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"bedrock-agent-runtime", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Agents for Amazon Bedrock Runtime", "serviceId":"Bedrock Agent Runtime", "signatureVersion":"v4", "signingName":"bedrock", - "uid":"bedrock-agent-runtime-2023-07-26" + "uid":"bedrock-agent-runtime-2023-07-26", + "auth":["aws.auth#sigv4"] }, "operations":{ "DeleteAgentMemory":{ @@ -1722,7 +1724,6 @@ "RetrievalFilterList":{ "type":"list", "member":{"shape":"RetrievalFilter"}, - "max":5, "min":2 }, "RetrievalResultConfluenceLocation":{ diff --git a/src/data/bedrock-agent-runtime/2023-07-26/api-2.json.php b/src/data/bedrock-agent-runtime/2023-07-26/api-2.json.php index cd09d4fbbe..4d7822736f 100644 --- a/src/data/bedrock-agent-runtime/2023-07-26/api-2.json.php +++ b/src/data/bedrock-agent-runtime/2023-07-26/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2023-07-26', 'endpointPrefix' => 'bedrock-agent-runtime', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Agents for Amazon Bedrock Runtime', 'serviceId' => 'Bedrock Agent Runtime', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-agent-runtime-2023-07-26', ], 'operations' => [ 'DeleteAgentMemory' => [ 'name' => 'DeleteAgentMemory', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/memories', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentMemoryRequest', ], 'output' => [ 'shape' => 'DeleteAgentMemoryResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'GetAgentMemory' => [ 'name' => 'GetAgentMemory', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/memories', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentMemoryRequest', ], 'output' => [ 'shape' => 'GetAgentMemoryResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'InvokeAgent' => [ 'name' => 'InvokeAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeAgentRequest', ], 'output' => [ 'shape' => 'InvokeAgentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'InvokeFlow' => [ 'name' => 'InvokeFlow', 'http' => [ 'method' => 'POST', 'requestUri' => '/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeFlowRequest', ], 'output' => [ 'shape' => 'InvokeFlowResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'Retrieve' => [ 'name' => 'Retrieve', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/retrieve', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RetrieveRequest', ], 'output' => [ 'shape' => 'RetrieveResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'RetrieveAndGenerate' => [ 'name' => 'RetrieveAndGenerate', 'http' => [ 'method' => 'POST', 'requestUri' => '/retrieveAndGenerate', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RetrieveAndGenerateRequest', ], 'output' => [ 'shape' => 'RetrieveAndGenerateResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionGroupInvocationInput' => [ 'type' => 'structure', 'members' => [ 'actionGroupName' => [ 'shape' => 'ActionGroupName', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'executionType' => [ 'shape' => 'ExecutionType', ], 'function' => [ 'shape' => 'Function', ], 'invocationId' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'Parameters', ], 'requestBody' => [ 'shape' => 'RequestBody', ], 'verb' => [ 'shape' => 'Verb', ], ], ], 'ActionGroupInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'ActionGroupOutputString', ], ], ], 'ActionGroupName' => [ 'type' => 'string', 'sensitive' => true, ], 'ActionGroupOutputString' => [ 'type' => 'string', 'sensitive' => true, ], 'ActionInvocationType' => [ 'type' => 'string', 'enum' => [ 'RESULT', 'USER_CONFIRMATION', 'USER_CONFIRMATION_AND_RESULT', ], ], 'AdditionalModelRequestFields' => [ 'type' => 'map', 'key' => [ 'shape' => 'AdditionalModelRequestFieldsKey', ], 'value' => [ 'shape' => 'AdditionalModelRequestFieldsValue', ], ], 'AdditionalModelRequestFieldsKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AdditionalModelRequestFieldsValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'AgentAliasId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'AgentId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'AgentVersion' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$', ], 'ApiContentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'PropertyParameters', ], ], 'ApiInvocationInput' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'actionInvocationType' => [ 'shape' => 'ActionInvocationType', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'httpMethod' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'ApiParameters', ], 'requestBody' => [ 'shape' => 'ApiRequestBody', ], ], ], 'ApiParameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'ApiParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApiParameter', ], ], 'ApiPath' => [ 'type' => 'string', 'sensitive' => true, ], 'ApiRequestBody' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'ApiContentMap', ], ], ], 'ApiResult' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'confirmationState' => [ 'shape' => 'ConfirmationState', ], 'httpMethod' => [ 'shape' => 'String', ], 'httpStatusCode' => [ 'shape' => 'Integer', ], 'responseBody' => [ 'shape' => 'ResponseBody', ], 'responseState' => [ 'shape' => 'ResponseState', ], ], ], 'Attribution' => [ 'type' => 'structure', 'members' => [ 'citations' => [ 'shape' => 'Citations', ], ], ], 'BadGatewayException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 502, ], 'exception' => true, 'fault' => true, ], 'BedrockModelArn' => [ 'type' => 'string', 'max' => 1011, 'min' => 20, 'pattern' => '^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'ByteContentBlob' => [ 'type' => 'blob', 'max' => 10485760, 'min' => 1, 'sensitive' => true, ], 'ByteContentDoc' => [ 'type' => 'structure', 'required' => [ 'contentType', 'data', 'identifier', ], 'members' => [ 'contentType' => [ 'shape' => 'ContentType', ], 'data' => [ 'shape' => 'ByteContentBlob', ], 'identifier' => [ 'shape' => 'Identifier', ], ], ], 'ByteContentFile' => [ 'type' => 'structure', 'required' => [ 'data', 'mediaType', ], 'members' => [ 'data' => [ 'shape' => 'ByteContentBlob', ], 'mediaType' => [ 'shape' => 'MimeType', ], ], ], 'Citation' => [ 'type' => 'structure', 'members' => [ 'generatedResponsePart' => [ 'shape' => 'GeneratedResponsePart', ], 'retrievedReferences' => [ 'shape' => 'RetrievedReferences', ], ], ], 'Citations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Citation', ], ], 'CodeInterpreterInvocationInput' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'String', ], 'files' => [ 'shape' => 'Files', ], ], ], 'CodeInterpreterInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'executionError' => [ 'shape' => 'String', ], 'executionOutput' => [ 'shape' => 'String', ], 'executionTimeout' => [ 'shape' => 'Boolean', ], 'files' => [ 'shape' => 'Files', ], ], ], 'ConfirmationState' => [ 'type' => 'string', 'enum' => [ 'CONFIRM', 'DENY', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ContentBody' => [ 'type' => 'structure', 'members' => [ 'body' => [ 'shape' => 'String', ], ], ], 'ContentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Parameters', ], ], 'ContentType' => [ 'type' => 'string', 'pattern' => '[a-z]{1,20}/.{1,20}', ], 'CreationMode' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'OVERRIDDEN', ], ], 'DateTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'DeleteAgentMemoryRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'querystring', 'locationName' => 'memoryId', ], ], ], 'DeleteAgentMemoryResponse' => [ 'type' => 'structure', 'members' => [], ], 'DependencyFailedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'Double' => [ 'type' => 'double', 'box' => true, ], 'ExecutionType' => [ 'type' => 'string', 'enum' => [ 'LAMBDA', 'RETURN_CONTROL', ], ], 'ExternalSource' => [ 'type' => 'structure', 'required' => [ 'sourceType', ], 'members' => [ 'byteContent' => [ 'shape' => 'ByteContentDoc', ], 's3Location' => [ 'shape' => 'S3ObjectDoc', ], 'sourceType' => [ 'shape' => 'ExternalSourceType', ], ], ], 'ExternalSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', 'BYTE_CONTENT', ], ], 'ExternalSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExternalSource', ], 'max' => 1, 'min' => 1, ], 'ExternalSourcesGenerationConfiguration' => [ 'type' => 'structure', 'members' => [ 'additionalModelRequestFields' => [ 'shape' => 'AdditionalModelRequestFields', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfig', ], 'promptTemplate' => [ 'shape' => 'PromptTemplate', ], ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'modelArn', 'sources', ], 'members' => [ 'generationConfiguration' => [ 'shape' => 'ExternalSourcesGenerationConfiguration', ], 'modelArn' => [ 'shape' => 'BedrockModelArn', ], 'sources' => [ 'shape' => 'ExternalSources', ], ], ], 'FailureReasonString' => [ 'type' => 'string', 'sensitive' => true, ], 'FailureTrace' => [ 'type' => 'structure', 'members' => [ 'failureReason' => [ 'shape' => 'FailureReasonString', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'FileBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'FilePart' => [ 'type' => 'structure', 'members' => [ 'files' => [ 'shape' => 'OutputFiles', ], ], 'event' => true, ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'sourceType', ], 'members' => [ 'byteContent' => [ 'shape' => 'ByteContentFile', ], 's3Location' => [ 'shape' => 'S3ObjectFile', ], 'sourceType' => [ 'shape' => 'FileSourceType', ], ], ], 'FileSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', 'BYTE_CONTENT', ], ], 'FileUseCase' => [ 'type' => 'string', 'enum' => [ 'CODE_INTERPRETER', 'CHAT', ], ], 'Files' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'FilterAttribute' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'FilterKey', ], 'value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'FilterValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'FinalResponse' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'FinalResponseString', ], ], ], 'FinalResponseString' => [ 'type' => 'string', 'sensitive' => true, ], 'FlowAliasIdentifier' => [ '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]+)$', ], 'FlowCompletionEvent' => [ 'type' => 'structure', 'required' => [ 'completionReason', ], 'members' => [ 'completionReason' => [ 'shape' => 'FlowCompletionReason', ], ], 'event' => true, 'sensitive' => true, ], 'FlowCompletionReason' => [ 'type' => 'string', 'enum' => [ 'SUCCESS', ], ], 'FlowIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$', ], 'FlowInput' => [ 'type' => 'structure', 'required' => [ 'content', 'nodeName', 'nodeOutputName', ], 'members' => [ 'content' => [ 'shape' => 'FlowInputContent', ], 'nodeName' => [ 'shape' => 'NodeName', ], 'nodeOutputName' => [ 'shape' => 'NodeOutputName', ], ], ], 'FlowInputContent' => [ 'type' => 'structure', 'members' => [ 'document' => [ 'shape' => 'Document', ], ], 'sensitive' => true, 'union' => true, ], 'FlowInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowInput', ], 'max' => 1, 'min' => 1, ], 'FlowOutputContent' => [ 'type' => 'structure', 'members' => [ 'document' => [ 'shape' => 'Document', ], ], 'union' => true, ], 'FlowOutputEvent' => [ 'type' => 'structure', 'required' => [ 'content', 'nodeName', 'nodeType', ], 'members' => [ 'content' => [ 'shape' => 'FlowOutputContent', ], 'nodeName' => [ 'shape' => 'NodeName', ], 'nodeType' => [ 'shape' => 'NodeType', ], ], 'event' => true, 'sensitive' => true, ], 'FlowResponseStream' => [ 'type' => 'structure', 'members' => [ 'accessDeniedException' => [ 'shape' => 'AccessDeniedException', ], 'badGatewayException' => [ 'shape' => 'BadGatewayException', ], 'conflictException' => [ 'shape' => 'ConflictException', ], 'dependencyFailedException' => [ 'shape' => 'DependencyFailedException', ], 'flowCompletionEvent' => [ 'shape' => 'FlowCompletionEvent', ], 'flowOutputEvent' => [ 'shape' => 'FlowOutputEvent', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'resourceNotFoundException' => [ 'shape' => 'ResourceNotFoundException', ], 'serviceQuotaExceededException' => [ 'shape' => 'ServiceQuotaExceededException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'validationException' => [ 'shape' => 'ValidationException', ], ], 'eventstream' => true, ], 'Function' => [ 'type' => 'string', 'sensitive' => true, ], 'FunctionInvocationInput' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'actionInvocationType' => [ 'shape' => 'ActionInvocationType', ], 'function' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'FunctionParameters', ], ], ], 'FunctionParameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'FunctionParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionParameter', ], ], 'FunctionResult' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'confirmationState' => [ 'shape' => 'ConfirmationState', ], 'function' => [ 'shape' => 'String', ], 'responseBody' => [ 'shape' => 'ResponseBody', ], 'responseState' => [ 'shape' => 'ResponseState', ], ], ], 'GeneratedResponsePart' => [ 'type' => 'structure', 'members' => [ 'textResponsePart' => [ 'shape' => 'TextResponsePart', ], ], ], 'GenerationConfiguration' => [ 'type' => 'structure', 'members' => [ 'additionalModelRequestFields' => [ 'shape' => 'AdditionalModelRequestFields', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfig', ], 'promptTemplate' => [ 'shape' => 'PromptTemplate', ], ], ], 'GetAgentMemoryRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', 'memoryId', 'memoryType', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxItems' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxItems', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'querystring', 'locationName' => 'memoryId', ], 'memoryType' => [ 'shape' => 'MemoryType', 'location' => 'querystring', 'locationName' => 'memoryType', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetAgentMemoryResponse' => [ 'type' => 'structure', 'members' => [ 'memoryContents' => [ 'shape' => 'Memories', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GuadrailAction' => [ 'type' => 'string', 'enum' => [ 'INTERVENED', 'NONE', ], ], 'GuardrailAction' => [ 'type' => 'string', 'enum' => [ 'INTERVENED', 'NONE', ], ], 'GuardrailAssessment' => [ 'type' => 'structure', 'members' => [ 'contentPolicy' => [ 'shape' => 'GuardrailContentPolicyAssessment', ], 'sensitiveInformationPolicy' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAssessment', ], 'topicPolicy' => [ 'shape' => 'GuardrailTopicPolicyAssessment', ], 'wordPolicy' => [ 'shape' => 'GuardrailWordPolicyAssessment', ], ], 'sensitive' => true, ], 'GuardrailAssessmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailId', 'guardrailVersion', ], 'members' => [ 'guardrailId' => [ 'shape' => 'GuardrailConfigurationGuardrailIdString', ], 'guardrailVersion' => [ 'shape' => 'GuardrailConfigurationGuardrailVersionString', ], ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '^[a-z0-9]+$', ], 'GuardrailConfigurationGuardrailVersionString' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(([1-9][0-9]{0,7})|(DRAFT))$', ], 'GuardrailContentFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailContentPolicyAction', ], 'confidence' => [ 'shape' => 'GuardrailContentFilterConfidence', ], 'type' => [ 'shape' => 'GuardrailContentFilterType', ], ], 'sensitive' => true, ], 'GuardrailContentFilterConfidence' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', ], ], 'GuardrailContentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentFilter', ], 'sensitive' => true, ], 'GuardrailContentFilterType' => [ 'type' => 'string', 'enum' => [ 'INSULTS', 'HATE', 'SEXUAL', 'VIOLENCE', 'MISCONDUCT', 'PROMPT_ATTACK', ], ], 'GuardrailContentPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailContentPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'GuardrailContentFilterList', ], ], 'sensitive' => true, ], 'GuardrailCustomWord' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], 'match' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'GuardrailCustomWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailCustomWord', ], 'sensitive' => true, ], 'GuardrailManagedWord' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailManagedWordType', ], ], 'sensitive' => true, ], 'GuardrailManagedWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailManagedWord', ], 'sensitive' => true, ], 'GuardrailManagedWordType' => [ 'type' => 'string', 'enum' => [ 'PROFANITY', ], ], 'GuardrailPiiEntityFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailPiiEntityType', ], ], 'sensitive' => true, ], 'GuardrailPiiEntityFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailPiiEntityFilter', ], 'sensitive' => true, ], 'GuardrailPiiEntityType' => [ 'type' => 'string', 'enum' => [ 'ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER', ], ], 'GuardrailRegexFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'regex' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'GuardrailRegexFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailRegexFilter', ], 'sensitive' => true, ], 'GuardrailSensitiveInformationPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', 'ANONYMIZED', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'piiEntities' => [ 'shape' => 'GuardrailPiiEntityFilterList', ], 'regexes' => [ 'shape' => 'GuardrailRegexFilterList', ], ], 'sensitive' => true, ], 'GuardrailTopic' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailTopicPolicyAction', ], 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailTopicType', ], ], 'sensitive' => true, ], 'GuardrailTopicList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailTopic', ], 'sensitive' => true, ], 'GuardrailTopicPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailTopicPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'topics' => [ 'shape' => 'GuardrailTopicList', ], ], 'sensitive' => true, ], 'GuardrailTopicType' => [ 'type' => 'string', 'enum' => [ 'DENY', ], ], 'GuardrailTrace' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailAction', ], 'inputAssessments' => [ 'shape' => 'GuardrailAssessmentList', ], 'outputAssessments' => [ 'shape' => 'GuardrailAssessmentList', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'GuardrailWordPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailWordPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'customWords' => [ 'shape' => 'GuardrailCustomWordList', ], 'managedWordLists' => [ 'shape' => 'GuardrailManagedWordList', ], ], 'sensitive' => true, ], 'Identifier' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'sensitive' => true, ], 'InferenceConfig' => [ 'type' => 'structure', 'members' => [ 'textInferenceConfig' => [ 'shape' => 'TextInferenceConfig', ], ], ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumLength' => [ 'shape' => 'MaximumLength', ], 'stopSequences' => [ 'shape' => 'StopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topK' => [ 'shape' => 'TopK', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'InputFile' => [ 'type' => 'structure', 'required' => [ 'name', 'source', 'useCase', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'source' => [ 'shape' => 'FileSource', ], 'useCase' => [ 'shape' => 'FileUseCase', ], ], ], 'InputFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputFile', ], ], 'InputText' => [ 'type' => 'string', 'max' => 25000000, 'min' => 0, 'sensitive' => true, ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvocationInput' => [ 'type' => 'structure', 'members' => [ 'actionGroupInvocationInput' => [ 'shape' => 'ActionGroupInvocationInput', ], 'codeInterpreterInvocationInput' => [ 'shape' => 'CodeInterpreterInvocationInput', ], 'invocationType' => [ 'shape' => 'InvocationType', ], 'knowledgeBaseLookupInput' => [ 'shape' => 'KnowledgeBaseLookupInput', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'InvocationInputMember' => [ 'type' => 'structure', 'members' => [ 'apiInvocationInput' => [ 'shape' => 'ApiInvocationInput', ], 'functionInvocationInput' => [ 'shape' => 'FunctionInvocationInput', ], ], 'union' => true, ], 'InvocationInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvocationInputMember', ], 'max' => 5, 'min' => 1, ], 'InvocationResultMember' => [ 'type' => 'structure', 'members' => [ 'apiResult' => [ 'shape' => 'ApiResult', ], 'functionResult' => [ 'shape' => 'FunctionResult', ], ], 'union' => true, ], 'InvocationType' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'FINISH', 'ACTION_GROUP_CODE_INTERPRETER', ], ], 'InvokeAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', 'sessionId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'enableTrace' => [ 'shape' => 'Boolean', ], 'endSession' => [ 'shape' => 'Boolean', ], 'inputText' => [ 'shape' => 'InputText', ], 'memoryId' => [ 'shape' => 'MemoryId', ], 'sessionId' => [ 'shape' => 'SessionId', 'location' => 'uri', 'locationName' => 'sessionId', ], 'sessionState' => [ 'shape' => 'SessionState', ], ], ], 'InvokeAgentResponse' => [ 'type' => 'structure', 'required' => [ 'completion', 'contentType', 'sessionId', ], 'members' => [ 'completion' => [ 'shape' => 'ResponseStream', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'x-amzn-bedrock-agent-content-type', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'header', 'locationName' => 'x-amz-bedrock-agent-memory-id', ], 'sessionId' => [ 'shape' => 'SessionId', 'location' => 'header', 'locationName' => 'x-amz-bedrock-agent-session-id', ], ], 'payload' => 'completion', ], 'InvokeFlowRequest' => [ 'type' => 'structure', 'required' => [ 'flowAliasIdentifier', 'flowIdentifier', 'inputs', ], 'members' => [ 'flowAliasIdentifier' => [ 'shape' => 'FlowAliasIdentifier', 'location' => 'uri', 'locationName' => 'flowAliasIdentifier', ], 'flowIdentifier' => [ 'shape' => 'FlowIdentifier', 'location' => 'uri', 'locationName' => 'flowIdentifier', ], 'inputs' => [ 'shape' => 'FlowInputs', ], ], ], 'InvokeFlowResponse' => [ 'type' => 'structure', 'required' => [ 'responseStream', ], 'members' => [ 'responseStream' => [ 'shape' => 'FlowResponseStream', ], ], 'payload' => 'responseStream', ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$', ], 'KnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'retrievalConfiguration', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], ], ], 'KnowledgeBaseConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'min' => 1, ], 'KnowledgeBaseId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'KnowledgeBaseLookupInput' => [ 'type' => 'structure', 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'TraceKnowledgeBaseId', ], 'text' => [ 'shape' => 'KnowledgeBaseLookupInputString', ], ], ], 'KnowledgeBaseLookupInputString' => [ 'type' => 'string', 'sensitive' => true, ], 'KnowledgeBaseLookupOutput' => [ 'type' => 'structure', 'members' => [ 'retrievedReferences' => [ 'shape' => 'RetrievedReferences', ], ], ], 'KnowledgeBaseQuery' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'KnowledgeBaseQueryTextString', ], ], 'sensitive' => true, ], 'KnowledgeBaseQueryTextString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'KnowledgeBaseRetrievalConfiguration' => [ 'type' => 'structure', 'required' => [ 'vectorSearchConfiguration', ], 'members' => [ 'vectorSearchConfiguration' => [ 'shape' => 'KnowledgeBaseVectorSearchConfiguration', ], ], ], 'KnowledgeBaseRetrievalResult' => [ 'type' => 'structure', 'required' => [ 'content', ], 'members' => [ 'content' => [ 'shape' => 'RetrievalResultContent', ], 'location' => [ 'shape' => 'RetrievalResultLocation', ], 'metadata' => [ 'shape' => 'RetrievalResultMetadata', ], 'score' => [ 'shape' => 'Double', ], ], ], 'KnowledgeBaseRetrievalResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseRetrievalResult', ], 'sensitive' => true, ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'modelArn', ], 'members' => [ 'generationConfiguration' => [ 'shape' => 'GenerationConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', ], 'modelArn' => [ 'shape' => 'BedrockModelArn', ], 'orchestrationConfiguration' => [ 'shape' => 'OrchestrationConfiguration', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'RetrievalFilter', ], 'numberOfResults' => [ 'shape' => 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger', 'box' => true, ], 'overrideSearchType' => [ 'shape' => 'SearchType', ], ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'LambdaArn' => [ 'type' => 'string', ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'MaxTokens' => [ 'type' => 'integer', 'box' => true, 'max' => 65536, 'min' => 0, ], 'MaximumLength' => [ 'type' => 'integer', 'box' => true, 'max' => 4096, 'min' => 0, ], 'Memories' => [ 'type' => 'list', 'member' => [ 'shape' => 'Memory', ], ], 'Memory' => [ 'type' => 'structure', 'members' => [ 'sessionSummary' => [ 'shape' => 'MemorySessionSummary', ], ], 'union' => true, ], 'MemoryId' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '^[0-9a-zA-Z._:-]+$', ], 'MemorySessionSummary' => [ 'type' => 'structure', 'members' => [ 'memoryId' => [ 'shape' => 'MemoryId', ], 'sessionExpiryTime' => [ 'shape' => 'DateTimestamp', ], 'sessionId' => [ 'shape' => 'SessionId', ], 'sessionStartTime' => [ 'shape' => 'DateTimestamp', ], 'summaryText' => [ 'shape' => 'SummaryText', ], ], ], 'MemoryType' => [ 'type' => 'string', 'enum' => [ 'SESSION_SUMMARY', ], ], 'Metadata' => [ 'type' => 'structure', 'members' => [ 'usage' => [ 'shape' => 'Usage', ], ], 'sensitive' => true, ], 'MimeType' => [ 'type' => 'string', ], 'ModelInvocationInput' => [ 'type' => 'structure', 'members' => [ 'inferenceConfiguration' => [ 'shape' => 'InferenceConfiguration', ], 'overrideLambda' => [ 'shape' => 'LambdaArn', ], 'parserMode' => [ 'shape' => 'CreationMode', ], 'promptCreationMode' => [ 'shape' => 'CreationMode', ], 'text' => [ 'shape' => 'PromptText', ], 'traceId' => [ 'shape' => 'TraceId', ], 'type' => [ 'shape' => 'PromptType', ], ], 'sensitive' => true, ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^\\S*$', ], 'NodeName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$', ], 'NodeOutputName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$', ], 'NodeType' => [ 'type' => 'string', 'enum' => [ 'FlowInputNode', 'FlowOutputNode', 'LambdaFunctionNode', 'KnowledgeBaseNode', 'PromptNode', 'ConditionNode', 'LexNode', ], ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '^[\\s\\S]*$', ], 'Observation' => [ 'type' => 'structure', 'members' => [ 'actionGroupInvocationOutput' => [ 'shape' => 'ActionGroupInvocationOutput', ], 'codeInterpreterInvocationOutput' => [ 'shape' => 'CodeInterpreterInvocationOutput', ], 'finalResponse' => [ 'shape' => 'FinalResponse', ], 'knowledgeBaseLookupOutput' => [ 'shape' => 'KnowledgeBaseLookupOutput', ], 'repromptResponse' => [ 'shape' => 'RepromptResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], 'type' => [ 'shape' => 'Type', ], ], 'sensitive' => true, ], 'OrchestrationConfiguration' => [ 'type' => 'structure', 'required' => [ 'queryTransformationConfiguration', ], 'members' => [ 'queryTransformationConfiguration' => [ 'shape' => 'QueryTransformationConfiguration', ], ], ], 'OrchestrationModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'metadata' => [ 'shape' => 'Metadata', ], 'rawResponse' => [ 'shape' => 'RawResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'OrchestrationTrace' => [ 'type' => 'structure', 'members' => [ 'invocationInput' => [ 'shape' => 'InvocationInput', ], 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'OrchestrationModelInvocationOutput', ], 'observation' => [ 'shape' => 'Observation', ], 'rationale' => [ 'shape' => 'Rationale', ], ], 'sensitive' => true, 'union' => true, ], 'OutputFile' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'FileBody', ], 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'MimeType', ], ], 'sensitive' => true, ], 'OutputFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputFile', ], 'max' => 5, 'min' => 0, ], 'OutputString' => [ 'type' => 'string', 'sensitive' => true, ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], ], 'Parameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], ], 'PartBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'PayloadPart' => [ 'type' => 'structure', 'members' => [ 'attribution' => [ 'shape' => 'Attribution', ], 'bytes' => [ 'shape' => 'PartBody', ], ], 'event' => true, 'sensitive' => true, ], 'PostProcessingModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'parsedResponse' => [ 'shape' => 'PostProcessingParsedResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'PostProcessingParsedResponse' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'OutputString', ], ], 'sensitive' => true, ], 'PostProcessingTrace' => [ 'type' => 'structure', 'members' => [ 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'PostProcessingModelInvocationOutput', ], ], 'sensitive' => true, 'union' => true, ], 'PreProcessingModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'parsedResponse' => [ 'shape' => 'PreProcessingParsedResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'PreProcessingParsedResponse' => [ 'type' => 'structure', 'members' => [ 'isValid' => [ 'shape' => 'Boolean', ], 'rationale' => [ 'shape' => 'RationaleString', ], ], 'sensitive' => true, ], 'PreProcessingTrace' => [ 'type' => 'structure', 'members' => [ 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'PreProcessingModelInvocationOutput', ], ], 'sensitive' => true, 'union' => true, ], 'PromptSessionAttributesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'PromptTemplate' => [ 'type' => 'structure', 'members' => [ 'textPromptTemplate' => [ 'shape' => 'TextPromptTemplate', ], ], ], 'PromptText' => [ 'type' => 'string', 'sensitive' => true, ], 'PromptType' => [ 'type' => 'string', 'enum' => [ 'PRE_PROCESSING', 'ORCHESTRATION', 'KNOWLEDGE_BASE_RESPONSE_GENERATION', 'POST_PROCESSING', ], ], 'PropertyParameters' => [ 'type' => 'structure', 'members' => [ 'properties' => [ 'shape' => 'ParameterList', ], ], ], 'QueryTransformationConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'QueryTransformationType', ], ], ], 'QueryTransformationType' => [ 'type' => 'string', 'enum' => [ 'QUERY_DECOMPOSITION', ], ], 'RAGStopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'RAGStopSequencesMemberString', ], 'max' => 4, 'min' => 0, ], 'RAGStopSequencesMemberString' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'Rationale' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'RationaleString', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'RationaleString' => [ 'type' => 'string', 'sensitive' => true, ], 'RawResponse' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RepromptResponse' => [ 'type' => 'structure', 'members' => [ 'source' => [ 'shape' => 'Source', ], 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RequestBody' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'ContentMap', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseBody' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'ContentBody', ], ], 'ResponseState' => [ 'type' => 'string', 'enum' => [ 'FAILURE', 'REPROMPT', ], ], 'ResponseStream' => [ 'type' => 'structure', 'members' => [ 'accessDeniedException' => [ 'shape' => 'AccessDeniedException', ], 'badGatewayException' => [ 'shape' => 'BadGatewayException', ], 'chunk' => [ 'shape' => 'PayloadPart', ], 'conflictException' => [ 'shape' => 'ConflictException', ], 'dependencyFailedException' => [ 'shape' => 'DependencyFailedException', ], 'files' => [ 'shape' => 'FilePart', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'resourceNotFoundException' => [ 'shape' => 'ResourceNotFoundException', ], 'returnControl' => [ 'shape' => 'ReturnControlPayload', ], 'serviceQuotaExceededException' => [ 'shape' => 'ServiceQuotaExceededException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'trace' => [ 'shape' => 'TracePart', ], 'validationException' => [ 'shape' => 'ValidationException', ], ], 'eventstream' => true, ], 'RetrievalFilter' => [ 'type' => 'structure', 'members' => [ 'andAll' => [ 'shape' => 'RetrievalFilterList', ], 'equals' => [ 'shape' => 'FilterAttribute', ], 'greaterThan' => [ 'shape' => 'FilterAttribute', ], 'greaterThanOrEquals' => [ 'shape' => 'FilterAttribute', ], 'in' => [ 'shape' => 'FilterAttribute', ], 'lessThan' => [ 'shape' => 'FilterAttribute', ], 'lessThanOrEquals' => [ 'shape' => 'FilterAttribute', ], 'listContains' => [ 'shape' => 'FilterAttribute', ], 'notEquals' => [ 'shape' => 'FilterAttribute', ], 'notIn' => [ 'shape' => 'FilterAttribute', ], 'orAll' => [ 'shape' => 'RetrievalFilterList', ], 'startsWith' => [ 'shape' => 'FilterAttribute', ], 'stringContains' => [ 'shape' => 'FilterAttribute', ], ], 'sensitive' => true, 'union' => true, ], 'RetrievalFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetrievalFilter', ], 'max' => 5, 'min' => 2, ], 'RetrievalResultConfluenceLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultContent' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RetrievalResultLocation' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'confluenceLocation' => [ 'shape' => 'RetrievalResultConfluenceLocation', ], 's3Location' => [ 'shape' => 'RetrievalResultS3Location', ], 'salesforceLocation' => [ 'shape' => 'RetrievalResultSalesforceLocation', ], 'sharePointLocation' => [ 'shape' => 'RetrievalResultSharePointLocation', ], 'type' => [ 'shape' => 'RetrievalResultLocationType', ], 'webLocation' => [ 'shape' => 'RetrievalResultWebLocation', ], ], 'sensitive' => true, ], 'RetrievalResultLocationType' => [ 'type' => 'string', 'enum' => [ 'S3', 'WEB', 'CONFLUENCE', 'SALESFORCE', 'SHAREPOINT', ], ], 'RetrievalResultMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'RetrievalResultMetadataKey', ], 'value' => [ 'shape' => 'RetrievalResultMetadataValue', ], 'min' => 1, 'sensitive' => true, ], 'RetrievalResultMetadataKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RetrievalResultMetadataValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'RetrievalResultS3Location' => [ 'type' => 'structure', 'members' => [ 'uri' => [ 'shape' => 'String', ], ], ], 'RetrievalResultSalesforceLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultSharePointLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultWebLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'externalSourcesConfiguration' => [ 'shape' => 'ExternalSourcesRetrieveAndGenerateConfiguration', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseRetrieveAndGenerateConfiguration', ], 'type' => [ 'shape' => 'RetrieveAndGenerateType', ], ], ], 'RetrieveAndGenerateInput' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'RetrieveAndGenerateInputTextString', ], ], 'sensitive' => true, ], 'RetrieveAndGenerateInputTextString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'RetrieveAndGenerateOutput' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RetrieveAndGenerateRequest' => [ 'type' => 'structure', 'required' => [ 'input', ], 'members' => [ 'input' => [ 'shape' => 'RetrieveAndGenerateInput', ], 'retrieveAndGenerateConfiguration' => [ 'shape' => 'RetrieveAndGenerateConfiguration', ], 'sessionConfiguration' => [ 'shape' => 'RetrieveAndGenerateSessionConfiguration', ], 'sessionId' => [ 'shape' => 'SessionId', ], ], ], 'RetrieveAndGenerateResponse' => [ 'type' => 'structure', 'required' => [ 'output', 'sessionId', ], 'members' => [ 'citations' => [ 'shape' => 'Citations', ], 'guardrailAction' => [ 'shape' => 'GuadrailAction', ], 'output' => [ 'shape' => 'RetrieveAndGenerateOutput', ], 'sessionId' => [ 'shape' => 'SessionId', ], ], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'type' => 'structure', 'required' => [ 'kmsKeyArn', ], 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'RetrieveAndGenerateType' => [ 'type' => 'string', 'enum' => [ 'KNOWLEDGE_BASE', 'EXTERNAL_SOURCES', ], ], 'RetrieveRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'retrievalQuery', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], 'retrievalQuery' => [ 'shape' => 'KnowledgeBaseQuery', ], ], ], 'RetrieveResponse' => [ 'type' => 'structure', 'required' => [ 'retrievalResults', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'retrievalResults' => [ 'shape' => 'KnowledgeBaseRetrievalResults', ], ], ], 'RetrievedReference' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'RetrievalResultContent', ], 'location' => [ 'shape' => 'RetrievalResultLocation', ], 'metadata' => [ 'shape' => 'RetrievalResultMetadata', ], ], ], 'RetrievedReferences' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetrievedReference', ], ], 'ReturnControlInvocationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvocationResultMember', ], 'max' => 5, 'min' => 1, ], 'ReturnControlPayload' => [ 'type' => 'structure', 'members' => [ 'invocationId' => [ 'shape' => 'String', ], 'invocationInputs' => [ 'shape' => 'InvocationInputs', ], ], 'event' => true, 'sensitive' => true, ], 'S3ObjectDoc' => [ 'type' => 'structure', 'required' => [ 'uri', ], 'members' => [ 'uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3ObjectFile' => [ 'type' => 'structure', 'required' => [ 'uri', ], 'members' => [ 'uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$', ], 'SearchType' => [ 'type' => 'string', 'enum' => [ 'HYBRID', 'SEMANTIC', ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SessionAttributesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SessionId' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '^[0-9a-zA-Z._:-]+$', ], 'SessionState' => [ 'type' => 'structure', 'members' => [ 'files' => [ 'shape' => 'InputFiles', ], 'invocationId' => [ 'shape' => 'String', ], 'knowledgeBaseConfigurations' => [ 'shape' => 'KnowledgeBaseConfigurations', ], 'promptSessionAttributes' => [ 'shape' => 'PromptSessionAttributesMap', ], 'returnControlInvocationResults' => [ 'shape' => 'ReturnControlInvocationResults', ], 'sessionAttributes' => [ 'shape' => 'SessionAttributesMap', ], ], ], 'Source' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'PARSER', ], 'sensitive' => true, ], 'Span' => [ 'type' => 'structure', 'members' => [ 'end' => [ 'shape' => 'SpanEndInteger', ], 'start' => [ 'shape' => 'SpanStartInteger', ], ], ], 'SpanEndInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'SpanStartInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'StopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 4, 'min' => 0, ], 'String' => [ 'type' => 'string', ], 'SummaryText' => [ 'type' => 'string', 'max' => 25000000, 'min' => 0, ], 'Temperature' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'TextInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'maxTokens' => [ 'shape' => 'MaxTokens', ], 'stopSequences' => [ 'shape' => 'RAGStopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'TextPromptTemplate' => [ 'type' => 'string', 'max' => 4000, 'min' => 1, 'sensitive' => true, ], 'TextResponsePart' => [ 'type' => 'structure', 'members' => [ 'span' => [ 'shape' => 'Span', ], 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TopK' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 0, ], 'TopP' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'Trace' => [ 'type' => 'structure', 'members' => [ 'failureTrace' => [ 'shape' => 'FailureTrace', ], 'guardrailTrace' => [ 'shape' => 'GuardrailTrace', ], 'orchestrationTrace' => [ 'shape' => 'OrchestrationTrace', ], 'postProcessingTrace' => [ 'shape' => 'PostProcessingTrace', ], 'preProcessingTrace' => [ 'shape' => 'PreProcessingTrace', ], ], 'sensitive' => true, 'union' => true, ], 'TraceId' => [ 'type' => 'string', 'max' => 16, 'min' => 2, ], 'TraceKnowledgeBaseId' => [ 'type' => 'string', 'sensitive' => true, ], 'TracePart' => [ 'type' => 'structure', 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', ], 'agentVersion' => [ 'shape' => 'AgentVersion', ], 'sessionId' => [ 'shape' => 'SessionId', ], 'trace' => [ 'shape' => 'Trace', ], ], 'event' => true, 'sensitive' => true, ], 'Type' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'FINISH', 'ASK_USER', 'REPROMPT', ], ], 'Usage' => [ 'type' => 'structure', 'members' => [ 'inputTokens' => [ 'shape' => 'Integer', ], 'outputTokens' => [ 'shape' => 'Integer', ], ], 'sensitive' => true, ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Verb' => [ 'type' => 'string', 'sensitive' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2023-07-26', 'endpointPrefix' => 'bedrock-agent-runtime', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Agents for Amazon Bedrock Runtime', 'serviceId' => 'Bedrock Agent Runtime', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-agent-runtime-2023-07-26', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'DeleteAgentMemory' => [ 'name' => 'DeleteAgentMemory', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/memories', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteAgentMemoryRequest', ], 'output' => [ 'shape' => 'DeleteAgentMemoryResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], 'idempotent' => true, ], 'GetAgentMemory' => [ 'name' => 'GetAgentMemory', 'http' => [ 'method' => 'GET', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/memories', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAgentMemoryRequest', ], 'output' => [ 'shape' => 'GetAgentMemoryResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'InvokeAgent' => [ 'name' => 'InvokeAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeAgentRequest', ], 'output' => [ 'shape' => 'InvokeAgentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'InvokeFlow' => [ 'name' => 'InvokeFlow', 'http' => [ 'method' => 'POST', 'requestUri' => '/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeFlowRequest', ], 'output' => [ 'shape' => 'InvokeFlowResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'Retrieve' => [ 'name' => 'Retrieve', 'http' => [ 'method' => 'POST', 'requestUri' => '/knowledgebases/{knowledgeBaseId}/retrieve', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RetrieveRequest', ], 'output' => [ 'shape' => 'RetrieveResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'RetrieveAndGenerate' => [ 'name' => 'RetrieveAndGenerate', 'http' => [ 'method' => 'POST', 'requestUri' => '/retrieveAndGenerate', 'responseCode' => 200, ], 'input' => [ 'shape' => 'RetrieveAndGenerateRequest', ], 'output' => [ 'shape' => 'RetrieveAndGenerateResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'DependencyFailedException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'ActionGroupInvocationInput' => [ 'type' => 'structure', 'members' => [ 'actionGroupName' => [ 'shape' => 'ActionGroupName', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'executionType' => [ 'shape' => 'ExecutionType', ], 'function' => [ 'shape' => 'Function', ], 'invocationId' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'Parameters', ], 'requestBody' => [ 'shape' => 'RequestBody', ], 'verb' => [ 'shape' => 'Verb', ], ], ], 'ActionGroupInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'ActionGroupOutputString', ], ], ], 'ActionGroupName' => [ 'type' => 'string', 'sensitive' => true, ], 'ActionGroupOutputString' => [ 'type' => 'string', 'sensitive' => true, ], 'ActionInvocationType' => [ 'type' => 'string', 'enum' => [ 'RESULT', 'USER_CONFIRMATION', 'USER_CONFIRMATION_AND_RESULT', ], ], 'AdditionalModelRequestFields' => [ 'type' => 'map', 'key' => [ 'shape' => 'AdditionalModelRequestFieldsKey', ], 'value' => [ 'shape' => 'AdditionalModelRequestFieldsValue', ], ], 'AdditionalModelRequestFieldsKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AdditionalModelRequestFieldsValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'AgentAliasId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'AgentId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'AgentVersion' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$', ], 'ApiContentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'PropertyParameters', ], ], 'ApiInvocationInput' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'actionInvocationType' => [ 'shape' => 'ActionInvocationType', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'httpMethod' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'ApiParameters', ], 'requestBody' => [ 'shape' => 'ApiRequestBody', ], ], ], 'ApiParameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'ApiParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApiParameter', ], ], 'ApiPath' => [ 'type' => 'string', 'sensitive' => true, ], 'ApiRequestBody' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'ApiContentMap', ], ], ], 'ApiResult' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'apiPath' => [ 'shape' => 'ApiPath', ], 'confirmationState' => [ 'shape' => 'ConfirmationState', ], 'httpMethod' => [ 'shape' => 'String', ], 'httpStatusCode' => [ 'shape' => 'Integer', ], 'responseBody' => [ 'shape' => 'ResponseBody', ], 'responseState' => [ 'shape' => 'ResponseState', ], ], ], 'Attribution' => [ 'type' => 'structure', 'members' => [ 'citations' => [ 'shape' => 'Citations', ], ], ], 'BadGatewayException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 502, ], 'exception' => true, 'fault' => true, ], 'BedrockModelArn' => [ 'type' => 'string', 'max' => 1011, 'min' => 20, 'pattern' => '^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))$', ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'ByteContentBlob' => [ 'type' => 'blob', 'max' => 10485760, 'min' => 1, 'sensitive' => true, ], 'ByteContentDoc' => [ 'type' => 'structure', 'required' => [ 'contentType', 'data', 'identifier', ], 'members' => [ 'contentType' => [ 'shape' => 'ContentType', ], 'data' => [ 'shape' => 'ByteContentBlob', ], 'identifier' => [ 'shape' => 'Identifier', ], ], ], 'ByteContentFile' => [ 'type' => 'structure', 'required' => [ 'data', 'mediaType', ], 'members' => [ 'data' => [ 'shape' => 'ByteContentBlob', ], 'mediaType' => [ 'shape' => 'MimeType', ], ], ], 'Citation' => [ 'type' => 'structure', 'members' => [ 'generatedResponsePart' => [ 'shape' => 'GeneratedResponsePart', ], 'retrievedReferences' => [ 'shape' => 'RetrievedReferences', ], ], ], 'Citations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Citation', ], ], 'CodeInterpreterInvocationInput' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'String', ], 'files' => [ 'shape' => 'Files', ], ], ], 'CodeInterpreterInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'executionError' => [ 'shape' => 'String', ], 'executionOutput' => [ 'shape' => 'String', ], 'executionTimeout' => [ 'shape' => 'Boolean', ], 'files' => [ 'shape' => 'Files', ], ], ], 'ConfirmationState' => [ 'type' => 'string', 'enum' => [ 'CONFIRM', 'DENY', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'ContentBody' => [ 'type' => 'structure', 'members' => [ 'body' => [ 'shape' => 'String', ], ], ], 'ContentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Parameters', ], ], 'ContentType' => [ 'type' => 'string', 'pattern' => '[a-z]{1,20}/.{1,20}', ], 'CreationMode' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'OVERRIDDEN', ], ], 'DateTimestamp' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'DeleteAgentMemoryRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'querystring', 'locationName' => 'memoryId', ], ], ], 'DeleteAgentMemoryResponse' => [ 'type' => 'structure', 'members' => [], ], 'DependencyFailedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'Double' => [ 'type' => 'double', 'box' => true, ], 'ExecutionType' => [ 'type' => 'string', 'enum' => [ 'LAMBDA', 'RETURN_CONTROL', ], ], 'ExternalSource' => [ 'type' => 'structure', 'required' => [ 'sourceType', ], 'members' => [ 'byteContent' => [ 'shape' => 'ByteContentDoc', ], 's3Location' => [ 'shape' => 'S3ObjectDoc', ], 'sourceType' => [ 'shape' => 'ExternalSourceType', ], ], ], 'ExternalSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', 'BYTE_CONTENT', ], ], 'ExternalSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExternalSource', ], 'max' => 1, 'min' => 1, ], 'ExternalSourcesGenerationConfiguration' => [ 'type' => 'structure', 'members' => [ 'additionalModelRequestFields' => [ 'shape' => 'AdditionalModelRequestFields', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfig', ], 'promptTemplate' => [ 'shape' => 'PromptTemplate', ], ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'modelArn', 'sources', ], 'members' => [ 'generationConfiguration' => [ 'shape' => 'ExternalSourcesGenerationConfiguration', ], 'modelArn' => [ 'shape' => 'BedrockModelArn', ], 'sources' => [ 'shape' => 'ExternalSources', ], ], ], 'FailureReasonString' => [ 'type' => 'string', 'sensitive' => true, ], 'FailureTrace' => [ 'type' => 'structure', 'members' => [ 'failureReason' => [ 'shape' => 'FailureReasonString', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'FileBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'FilePart' => [ 'type' => 'structure', 'members' => [ 'files' => [ 'shape' => 'OutputFiles', ], ], 'event' => true, ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'sourceType', ], 'members' => [ 'byteContent' => [ 'shape' => 'ByteContentFile', ], 's3Location' => [ 'shape' => 'S3ObjectFile', ], 'sourceType' => [ 'shape' => 'FileSourceType', ], ], ], 'FileSourceType' => [ 'type' => 'string', 'enum' => [ 'S3', 'BYTE_CONTENT', ], ], 'FileUseCase' => [ 'type' => 'string', 'enum' => [ 'CODE_INTERPRETER', 'CHAT', ], ], 'Files' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'FilterAttribute' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'FilterKey', ], 'value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'FilterValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'FinalResponse' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'FinalResponseString', ], ], ], 'FinalResponseString' => [ 'type' => 'string', 'sensitive' => true, ], 'FlowAliasIdentifier' => [ '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]+)$', ], 'FlowCompletionEvent' => [ 'type' => 'structure', 'required' => [ 'completionReason', ], 'members' => [ 'completionReason' => [ 'shape' => 'FlowCompletionReason', ], ], 'event' => true, 'sensitive' => true, ], 'FlowCompletionReason' => [ 'type' => 'string', 'enum' => [ 'SUCCESS', ], ], 'FlowIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$', ], 'FlowInput' => [ 'type' => 'structure', 'required' => [ 'content', 'nodeName', 'nodeOutputName', ], 'members' => [ 'content' => [ 'shape' => 'FlowInputContent', ], 'nodeName' => [ 'shape' => 'NodeName', ], 'nodeOutputName' => [ 'shape' => 'NodeOutputName', ], ], ], 'FlowInputContent' => [ 'type' => 'structure', 'members' => [ 'document' => [ 'shape' => 'Document', ], ], 'sensitive' => true, 'union' => true, ], 'FlowInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowInput', ], 'max' => 1, 'min' => 1, ], 'FlowOutputContent' => [ 'type' => 'structure', 'members' => [ 'document' => [ 'shape' => 'Document', ], ], 'union' => true, ], 'FlowOutputEvent' => [ 'type' => 'structure', 'required' => [ 'content', 'nodeName', 'nodeType', ], 'members' => [ 'content' => [ 'shape' => 'FlowOutputContent', ], 'nodeName' => [ 'shape' => 'NodeName', ], 'nodeType' => [ 'shape' => 'NodeType', ], ], 'event' => true, 'sensitive' => true, ], 'FlowResponseStream' => [ 'type' => 'structure', 'members' => [ 'accessDeniedException' => [ 'shape' => 'AccessDeniedException', ], 'badGatewayException' => [ 'shape' => 'BadGatewayException', ], 'conflictException' => [ 'shape' => 'ConflictException', ], 'dependencyFailedException' => [ 'shape' => 'DependencyFailedException', ], 'flowCompletionEvent' => [ 'shape' => 'FlowCompletionEvent', ], 'flowOutputEvent' => [ 'shape' => 'FlowOutputEvent', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'resourceNotFoundException' => [ 'shape' => 'ResourceNotFoundException', ], 'serviceQuotaExceededException' => [ 'shape' => 'ServiceQuotaExceededException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'validationException' => [ 'shape' => 'ValidationException', ], ], 'eventstream' => true, ], 'Function' => [ 'type' => 'string', 'sensitive' => true, ], 'FunctionInvocationInput' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'actionInvocationType' => [ 'shape' => 'ActionInvocationType', ], 'function' => [ 'shape' => 'String', ], 'parameters' => [ 'shape' => 'FunctionParameters', ], ], ], 'FunctionParameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'FunctionParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionParameter', ], ], 'FunctionResult' => [ 'type' => 'structure', 'required' => [ 'actionGroup', ], 'members' => [ 'actionGroup' => [ 'shape' => 'String', ], 'confirmationState' => [ 'shape' => 'ConfirmationState', ], 'function' => [ 'shape' => 'String', ], 'responseBody' => [ 'shape' => 'ResponseBody', ], 'responseState' => [ 'shape' => 'ResponseState', ], ], ], 'GeneratedResponsePart' => [ 'type' => 'structure', 'members' => [ 'textResponsePart' => [ 'shape' => 'TextResponsePart', ], ], ], 'GenerationConfiguration' => [ 'type' => 'structure', 'members' => [ 'additionalModelRequestFields' => [ 'shape' => 'AdditionalModelRequestFields', ], 'guardrailConfiguration' => [ 'shape' => 'GuardrailConfiguration', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfig', ], 'promptTemplate' => [ 'shape' => 'PromptTemplate', ], ], ], 'GetAgentMemoryRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', 'memoryId', 'memoryType', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'maxItems' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxItems', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'querystring', 'locationName' => 'memoryId', ], 'memoryType' => [ 'shape' => 'MemoryType', 'location' => 'querystring', 'locationName' => 'memoryType', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetAgentMemoryResponse' => [ 'type' => 'structure', 'members' => [ 'memoryContents' => [ 'shape' => 'Memories', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GuadrailAction' => [ 'type' => 'string', 'enum' => [ 'INTERVENED', 'NONE', ], ], 'GuardrailAction' => [ 'type' => 'string', 'enum' => [ 'INTERVENED', 'NONE', ], ], 'GuardrailAssessment' => [ 'type' => 'structure', 'members' => [ 'contentPolicy' => [ 'shape' => 'GuardrailContentPolicyAssessment', ], 'sensitiveInformationPolicy' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAssessment', ], 'topicPolicy' => [ 'shape' => 'GuardrailTopicPolicyAssessment', ], 'wordPolicy' => [ 'shape' => 'GuardrailWordPolicyAssessment', ], ], 'sensitive' => true, ], 'GuardrailAssessmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailId', 'guardrailVersion', ], 'members' => [ 'guardrailId' => [ 'shape' => 'GuardrailConfigurationGuardrailIdString', ], 'guardrailVersion' => [ 'shape' => 'GuardrailConfigurationGuardrailVersionString', ], ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '^[a-z0-9]+$', ], 'GuardrailConfigurationGuardrailVersionString' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^(([1-9][0-9]{0,7})|(DRAFT))$', ], 'GuardrailContentFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailContentPolicyAction', ], 'confidence' => [ 'shape' => 'GuardrailContentFilterConfidence', ], 'type' => [ 'shape' => 'GuardrailContentFilterType', ], ], 'sensitive' => true, ], 'GuardrailContentFilterConfidence' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', ], ], 'GuardrailContentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentFilter', ], 'sensitive' => true, ], 'GuardrailContentFilterType' => [ 'type' => 'string', 'enum' => [ 'INSULTS', 'HATE', 'SEXUAL', 'VIOLENCE', 'MISCONDUCT', 'PROMPT_ATTACK', ], ], 'GuardrailContentPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailContentPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'GuardrailContentFilterList', ], ], 'sensitive' => true, ], 'GuardrailCustomWord' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], 'match' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'GuardrailCustomWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailCustomWord', ], 'sensitive' => true, ], 'GuardrailManagedWord' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailManagedWordType', ], ], 'sensitive' => true, ], 'GuardrailManagedWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailManagedWord', ], 'sensitive' => true, ], 'GuardrailManagedWordType' => [ 'type' => 'string', 'enum' => [ 'PROFANITY', ], ], 'GuardrailPiiEntityFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailPiiEntityType', ], ], 'sensitive' => true, ], 'GuardrailPiiEntityFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailPiiEntityFilter', ], 'sensitive' => true, ], 'GuardrailPiiEntityType' => [ 'type' => 'string', 'enum' => [ 'ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER', ], ], 'GuardrailRegexFilter' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], 'match' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'regex' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'GuardrailRegexFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailRegexFilter', ], 'sensitive' => true, ], 'GuardrailSensitiveInformationPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', 'ANONYMIZED', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'piiEntities' => [ 'shape' => 'GuardrailPiiEntityFilterList', ], 'regexes' => [ 'shape' => 'GuardrailRegexFilterList', ], ], 'sensitive' => true, ], 'GuardrailTopic' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailTopicPolicyAction', ], 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailTopicType', ], ], 'sensitive' => true, ], 'GuardrailTopicList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailTopic', ], 'sensitive' => true, ], 'GuardrailTopicPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailTopicPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'topics' => [ 'shape' => 'GuardrailTopicList', ], ], 'sensitive' => true, ], 'GuardrailTopicType' => [ 'type' => 'string', 'enum' => [ 'DENY', ], ], 'GuardrailTrace' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'GuardrailAction', ], 'inputAssessments' => [ 'shape' => 'GuardrailAssessmentList', ], 'outputAssessments' => [ 'shape' => 'GuardrailAssessmentList', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'GuardrailWordPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailWordPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'customWords' => [ 'shape' => 'GuardrailCustomWordList', ], 'managedWordLists' => [ 'shape' => 'GuardrailManagedWordList', ], ], 'sensitive' => true, ], 'Identifier' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'sensitive' => true, ], 'InferenceConfig' => [ 'type' => 'structure', 'members' => [ 'textInferenceConfig' => [ 'shape' => 'TextInferenceConfig', ], ], ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumLength' => [ 'shape' => 'MaximumLength', ], 'stopSequences' => [ 'shape' => 'StopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topK' => [ 'shape' => 'TopK', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'InputFile' => [ 'type' => 'structure', 'required' => [ 'name', 'source', 'useCase', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'source' => [ 'shape' => 'FileSource', ], 'useCase' => [ 'shape' => 'FileUseCase', ], ], ], 'InputFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputFile', ], ], 'InputText' => [ 'type' => 'string', 'max' => 25000000, 'min' => 0, 'sensitive' => true, ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvocationInput' => [ 'type' => 'structure', 'members' => [ 'actionGroupInvocationInput' => [ 'shape' => 'ActionGroupInvocationInput', ], 'codeInterpreterInvocationInput' => [ 'shape' => 'CodeInterpreterInvocationInput', ], 'invocationType' => [ 'shape' => 'InvocationType', ], 'knowledgeBaseLookupInput' => [ 'shape' => 'KnowledgeBaseLookupInput', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'InvocationInputMember' => [ 'type' => 'structure', 'members' => [ 'apiInvocationInput' => [ 'shape' => 'ApiInvocationInput', ], 'functionInvocationInput' => [ 'shape' => 'FunctionInvocationInput', ], ], 'union' => true, ], 'InvocationInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvocationInputMember', ], 'max' => 5, 'min' => 1, ], 'InvocationResultMember' => [ 'type' => 'structure', 'members' => [ 'apiResult' => [ 'shape' => 'ApiResult', ], 'functionResult' => [ 'shape' => 'FunctionResult', ], ], 'union' => true, ], 'InvocationType' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'FINISH', 'ACTION_GROUP_CODE_INTERPRETER', ], ], 'InvokeAgentRequest' => [ 'type' => 'structure', 'required' => [ 'agentAliasId', 'agentId', 'sessionId', ], 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', 'location' => 'uri', 'locationName' => 'agentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', 'location' => 'uri', 'locationName' => 'agentId', ], 'enableTrace' => [ 'shape' => 'Boolean', ], 'endSession' => [ 'shape' => 'Boolean', ], 'inputText' => [ 'shape' => 'InputText', ], 'memoryId' => [ 'shape' => 'MemoryId', ], 'sessionId' => [ 'shape' => 'SessionId', 'location' => 'uri', 'locationName' => 'sessionId', ], 'sessionState' => [ 'shape' => 'SessionState', ], ], ], 'InvokeAgentResponse' => [ 'type' => 'structure', 'required' => [ 'completion', 'contentType', 'sessionId', ], 'members' => [ 'completion' => [ 'shape' => 'ResponseStream', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'x-amzn-bedrock-agent-content-type', ], 'memoryId' => [ 'shape' => 'MemoryId', 'location' => 'header', 'locationName' => 'x-amz-bedrock-agent-memory-id', ], 'sessionId' => [ 'shape' => 'SessionId', 'location' => 'header', 'locationName' => 'x-amz-bedrock-agent-session-id', ], ], 'payload' => 'completion', ], 'InvokeFlowRequest' => [ 'type' => 'structure', 'required' => [ 'flowAliasIdentifier', 'flowIdentifier', 'inputs', ], 'members' => [ 'flowAliasIdentifier' => [ 'shape' => 'FlowAliasIdentifier', 'location' => 'uri', 'locationName' => 'flowAliasIdentifier', ], 'flowIdentifier' => [ 'shape' => 'FlowIdentifier', 'location' => 'uri', 'locationName' => 'flowIdentifier', ], 'inputs' => [ 'shape' => 'FlowInputs', ], ], ], 'InvokeFlowResponse' => [ 'type' => 'structure', 'required' => [ 'responseStream', ], 'members' => [ 'responseStream' => [ 'shape' => 'FlowResponseStream', ], ], 'payload' => 'responseStream', ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$', ], 'KnowledgeBaseConfiguration' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'retrievalConfiguration', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], ], ], 'KnowledgeBaseConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseConfiguration', ], 'min' => 1, ], 'KnowledgeBaseId' => [ 'type' => 'string', 'max' => 10, 'min' => 0, 'pattern' => '^[0-9a-zA-Z]+$', ], 'KnowledgeBaseLookupInput' => [ 'type' => 'structure', 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'TraceKnowledgeBaseId', ], 'text' => [ 'shape' => 'KnowledgeBaseLookupInputString', ], ], ], 'KnowledgeBaseLookupInputString' => [ 'type' => 'string', 'sensitive' => true, ], 'KnowledgeBaseLookupOutput' => [ 'type' => 'structure', 'members' => [ 'retrievedReferences' => [ 'shape' => 'RetrievedReferences', ], ], ], 'KnowledgeBaseQuery' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'KnowledgeBaseQueryTextString', ], ], 'sensitive' => true, ], 'KnowledgeBaseQueryTextString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'KnowledgeBaseRetrievalConfiguration' => [ 'type' => 'structure', 'required' => [ 'vectorSearchConfiguration', ], 'members' => [ 'vectorSearchConfiguration' => [ 'shape' => 'KnowledgeBaseVectorSearchConfiguration', ], ], ], 'KnowledgeBaseRetrievalResult' => [ 'type' => 'structure', 'required' => [ 'content', ], 'members' => [ 'content' => [ 'shape' => 'RetrievalResultContent', ], 'location' => [ 'shape' => 'RetrievalResultLocation', ], 'metadata' => [ 'shape' => 'RetrievalResultMetadata', ], 'score' => [ 'shape' => 'Double', ], ], ], 'KnowledgeBaseRetrievalResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'KnowledgeBaseRetrievalResult', ], 'sensitive' => true, ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'modelArn', ], 'members' => [ 'generationConfiguration' => [ 'shape' => 'GenerationConfiguration', ], 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', ], 'modelArn' => [ 'shape' => 'BedrockModelArn', ], 'orchestrationConfiguration' => [ 'shape' => 'OrchestrationConfiguration', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'RetrievalFilter', ], 'numberOfResults' => [ 'shape' => 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger', 'box' => true, ], 'overrideSearchType' => [ 'shape' => 'SearchType', ], ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'LambdaArn' => [ 'type' => 'string', ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'MaxTokens' => [ 'type' => 'integer', 'box' => true, 'max' => 65536, 'min' => 0, ], 'MaximumLength' => [ 'type' => 'integer', 'box' => true, 'max' => 4096, 'min' => 0, ], 'Memories' => [ 'type' => 'list', 'member' => [ 'shape' => 'Memory', ], ], 'Memory' => [ 'type' => 'structure', 'members' => [ 'sessionSummary' => [ 'shape' => 'MemorySessionSummary', ], ], 'union' => true, ], 'MemoryId' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '^[0-9a-zA-Z._:-]+$', ], 'MemorySessionSummary' => [ 'type' => 'structure', 'members' => [ 'memoryId' => [ 'shape' => 'MemoryId', ], 'sessionExpiryTime' => [ 'shape' => 'DateTimestamp', ], 'sessionId' => [ 'shape' => 'SessionId', ], 'sessionStartTime' => [ 'shape' => 'DateTimestamp', ], 'summaryText' => [ 'shape' => 'SummaryText', ], ], ], 'MemoryType' => [ 'type' => 'string', 'enum' => [ 'SESSION_SUMMARY', ], ], 'Metadata' => [ 'type' => 'structure', 'members' => [ 'usage' => [ 'shape' => 'Usage', ], ], 'sensitive' => true, ], 'MimeType' => [ 'type' => 'string', ], 'ModelInvocationInput' => [ 'type' => 'structure', 'members' => [ 'inferenceConfiguration' => [ 'shape' => 'InferenceConfiguration', ], 'overrideLambda' => [ 'shape' => 'LambdaArn', ], 'parserMode' => [ 'shape' => 'CreationMode', ], 'promptCreationMode' => [ 'shape' => 'CreationMode', ], 'text' => [ 'shape' => 'PromptText', ], 'traceId' => [ 'shape' => 'TraceId', ], 'type' => [ 'shape' => 'PromptType', ], ], 'sensitive' => true, ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^\\S*$', ], 'NodeName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$', ], 'NodeOutputName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$', ], 'NodeType' => [ 'type' => 'string', 'enum' => [ 'FlowInputNode', 'FlowOutputNode', 'LambdaFunctionNode', 'KnowledgeBaseNode', 'PromptNode', 'ConditionNode', 'LexNode', ], ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '^[\\s\\S]*$', ], 'Observation' => [ 'type' => 'structure', 'members' => [ 'actionGroupInvocationOutput' => [ 'shape' => 'ActionGroupInvocationOutput', ], 'codeInterpreterInvocationOutput' => [ 'shape' => 'CodeInterpreterInvocationOutput', ], 'finalResponse' => [ 'shape' => 'FinalResponse', ], 'knowledgeBaseLookupOutput' => [ 'shape' => 'KnowledgeBaseLookupOutput', ], 'repromptResponse' => [ 'shape' => 'RepromptResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], 'type' => [ 'shape' => 'Type', ], ], 'sensitive' => true, ], 'OrchestrationConfiguration' => [ 'type' => 'structure', 'required' => [ 'queryTransformationConfiguration', ], 'members' => [ 'queryTransformationConfiguration' => [ 'shape' => 'QueryTransformationConfiguration', ], ], ], 'OrchestrationModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'metadata' => [ 'shape' => 'Metadata', ], 'rawResponse' => [ 'shape' => 'RawResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'OrchestrationTrace' => [ 'type' => 'structure', 'members' => [ 'invocationInput' => [ 'shape' => 'InvocationInput', ], 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'OrchestrationModelInvocationOutput', ], 'observation' => [ 'shape' => 'Observation', ], 'rationale' => [ 'shape' => 'Rationale', ], ], 'sensitive' => true, 'union' => true, ], 'OutputFile' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'FileBody', ], 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'MimeType', ], ], 'sensitive' => true, ], 'OutputFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputFile', ], 'max' => 5, 'min' => 0, ], 'OutputString' => [ 'type' => 'string', 'sensitive' => true, ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], ], 'Parameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], ], 'PartBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'PayloadPart' => [ 'type' => 'structure', 'members' => [ 'attribution' => [ 'shape' => 'Attribution', ], 'bytes' => [ 'shape' => 'PartBody', ], ], 'event' => true, 'sensitive' => true, ], 'PostProcessingModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'parsedResponse' => [ 'shape' => 'PostProcessingParsedResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'PostProcessingParsedResponse' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'OutputString', ], ], 'sensitive' => true, ], 'PostProcessingTrace' => [ 'type' => 'structure', 'members' => [ 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'PostProcessingModelInvocationOutput', ], ], 'sensitive' => true, 'union' => true, ], 'PreProcessingModelInvocationOutput' => [ 'type' => 'structure', 'members' => [ 'parsedResponse' => [ 'shape' => 'PreProcessingParsedResponse', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'PreProcessingParsedResponse' => [ 'type' => 'structure', 'members' => [ 'isValid' => [ 'shape' => 'Boolean', ], 'rationale' => [ 'shape' => 'RationaleString', ], ], 'sensitive' => true, ], 'PreProcessingTrace' => [ 'type' => 'structure', 'members' => [ 'modelInvocationInput' => [ 'shape' => 'ModelInvocationInput', ], 'modelInvocationOutput' => [ 'shape' => 'PreProcessingModelInvocationOutput', ], ], 'sensitive' => true, 'union' => true, ], 'PromptSessionAttributesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'PromptTemplate' => [ 'type' => 'structure', 'members' => [ 'textPromptTemplate' => [ 'shape' => 'TextPromptTemplate', ], ], ], 'PromptText' => [ 'type' => 'string', 'sensitive' => true, ], 'PromptType' => [ 'type' => 'string', 'enum' => [ 'PRE_PROCESSING', 'ORCHESTRATION', 'KNOWLEDGE_BASE_RESPONSE_GENERATION', 'POST_PROCESSING', ], ], 'PropertyParameters' => [ 'type' => 'structure', 'members' => [ 'properties' => [ 'shape' => 'ParameterList', ], ], ], 'QueryTransformationConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'QueryTransformationType', ], ], ], 'QueryTransformationType' => [ 'type' => 'string', 'enum' => [ 'QUERY_DECOMPOSITION', ], ], 'RAGStopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'RAGStopSequencesMemberString', ], 'max' => 4, 'min' => 0, ], 'RAGStopSequencesMemberString' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'Rationale' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'RationaleString', ], 'traceId' => [ 'shape' => 'TraceId', ], ], 'sensitive' => true, ], 'RationaleString' => [ 'type' => 'string', 'sensitive' => true, ], 'RawResponse' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RepromptResponse' => [ 'type' => 'structure', 'members' => [ 'source' => [ 'shape' => 'Source', ], 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RequestBody' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'ContentMap', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseBody' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'ContentBody', ], ], 'ResponseState' => [ 'type' => 'string', 'enum' => [ 'FAILURE', 'REPROMPT', ], ], 'ResponseStream' => [ 'type' => 'structure', 'members' => [ 'accessDeniedException' => [ 'shape' => 'AccessDeniedException', ], 'badGatewayException' => [ 'shape' => 'BadGatewayException', ], 'chunk' => [ 'shape' => 'PayloadPart', ], 'conflictException' => [ 'shape' => 'ConflictException', ], 'dependencyFailedException' => [ 'shape' => 'DependencyFailedException', ], 'files' => [ 'shape' => 'FilePart', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'resourceNotFoundException' => [ 'shape' => 'ResourceNotFoundException', ], 'returnControl' => [ 'shape' => 'ReturnControlPayload', ], 'serviceQuotaExceededException' => [ 'shape' => 'ServiceQuotaExceededException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'trace' => [ 'shape' => 'TracePart', ], 'validationException' => [ 'shape' => 'ValidationException', ], ], 'eventstream' => true, ], 'RetrievalFilter' => [ 'type' => 'structure', 'members' => [ 'andAll' => [ 'shape' => 'RetrievalFilterList', ], 'equals' => [ 'shape' => 'FilterAttribute', ], 'greaterThan' => [ 'shape' => 'FilterAttribute', ], 'greaterThanOrEquals' => [ 'shape' => 'FilterAttribute', ], 'in' => [ 'shape' => 'FilterAttribute', ], 'lessThan' => [ 'shape' => 'FilterAttribute', ], 'lessThanOrEquals' => [ 'shape' => 'FilterAttribute', ], 'listContains' => [ 'shape' => 'FilterAttribute', ], 'notEquals' => [ 'shape' => 'FilterAttribute', ], 'notIn' => [ 'shape' => 'FilterAttribute', ], 'orAll' => [ 'shape' => 'RetrievalFilterList', ], 'startsWith' => [ 'shape' => 'FilterAttribute', ], 'stringContains' => [ 'shape' => 'FilterAttribute', ], ], 'sensitive' => true, 'union' => true, ], 'RetrievalFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetrievalFilter', ], 'min' => 2, ], 'RetrievalResultConfluenceLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultContent' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RetrievalResultLocation' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'confluenceLocation' => [ 'shape' => 'RetrievalResultConfluenceLocation', ], 's3Location' => [ 'shape' => 'RetrievalResultS3Location', ], 'salesforceLocation' => [ 'shape' => 'RetrievalResultSalesforceLocation', ], 'sharePointLocation' => [ 'shape' => 'RetrievalResultSharePointLocation', ], 'type' => [ 'shape' => 'RetrievalResultLocationType', ], 'webLocation' => [ 'shape' => 'RetrievalResultWebLocation', ], ], 'sensitive' => true, ], 'RetrievalResultLocationType' => [ 'type' => 'string', 'enum' => [ 'S3', 'WEB', 'CONFLUENCE', 'SALESFORCE', 'SHAREPOINT', ], ], 'RetrievalResultMetadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'RetrievalResultMetadataKey', ], 'value' => [ 'shape' => 'RetrievalResultMetadataValue', ], 'min' => 1, 'sensitive' => true, ], 'RetrievalResultMetadataKey' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RetrievalResultMetadataValue' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'RetrievalResultS3Location' => [ 'type' => 'structure', 'members' => [ 'uri' => [ 'shape' => 'String', ], ], ], 'RetrievalResultSalesforceLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultSharePointLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrievalResultWebLocation' => [ 'type' => 'structure', 'members' => [ 'url' => [ 'shape' => 'String', ], ], ], 'RetrieveAndGenerateConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'externalSourcesConfiguration' => [ 'shape' => 'ExternalSourcesRetrieveAndGenerateConfiguration', ], 'knowledgeBaseConfiguration' => [ 'shape' => 'KnowledgeBaseRetrieveAndGenerateConfiguration', ], 'type' => [ 'shape' => 'RetrieveAndGenerateType', ], ], ], 'RetrieveAndGenerateInput' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'RetrieveAndGenerateInputTextString', ], ], 'sensitive' => true, ], 'RetrieveAndGenerateInputTextString' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, ], 'RetrieveAndGenerateOutput' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'RetrieveAndGenerateRequest' => [ 'type' => 'structure', 'required' => [ 'input', ], 'members' => [ 'input' => [ 'shape' => 'RetrieveAndGenerateInput', ], 'retrieveAndGenerateConfiguration' => [ 'shape' => 'RetrieveAndGenerateConfiguration', ], 'sessionConfiguration' => [ 'shape' => 'RetrieveAndGenerateSessionConfiguration', ], 'sessionId' => [ 'shape' => 'SessionId', ], ], ], 'RetrieveAndGenerateResponse' => [ 'type' => 'structure', 'required' => [ 'output', 'sessionId', ], 'members' => [ 'citations' => [ 'shape' => 'Citations', ], 'guardrailAction' => [ 'shape' => 'GuadrailAction', ], 'output' => [ 'shape' => 'RetrieveAndGenerateOutput', ], 'sessionId' => [ 'shape' => 'SessionId', ], ], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'type' => 'structure', 'required' => [ 'kmsKeyArn', ], 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'RetrieveAndGenerateType' => [ 'type' => 'string', 'enum' => [ 'KNOWLEDGE_BASE', 'EXTERNAL_SOURCES', ], ], 'RetrieveRequest' => [ 'type' => 'structure', 'required' => [ 'knowledgeBaseId', 'retrievalQuery', ], 'members' => [ 'knowledgeBaseId' => [ 'shape' => 'KnowledgeBaseId', 'location' => 'uri', 'locationName' => 'knowledgeBaseId', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'retrievalConfiguration' => [ 'shape' => 'KnowledgeBaseRetrievalConfiguration', ], 'retrievalQuery' => [ 'shape' => 'KnowledgeBaseQuery', ], ], ], 'RetrieveResponse' => [ 'type' => 'structure', 'required' => [ 'retrievalResults', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'retrievalResults' => [ 'shape' => 'KnowledgeBaseRetrievalResults', ], ], ], 'RetrievedReference' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'RetrievalResultContent', ], 'location' => [ 'shape' => 'RetrievalResultLocation', ], 'metadata' => [ 'shape' => 'RetrievalResultMetadata', ], ], ], 'RetrievedReferences' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetrievedReference', ], ], 'ReturnControlInvocationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvocationResultMember', ], 'max' => 5, 'min' => 1, ], 'ReturnControlPayload' => [ 'type' => 'structure', 'members' => [ 'invocationId' => [ 'shape' => 'String', ], 'invocationInputs' => [ 'shape' => 'InvocationInputs', ], ], 'event' => true, 'sensitive' => true, ], 'S3ObjectDoc' => [ 'type' => 'structure', 'required' => [ 'uri', ], 'members' => [ 'uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3ObjectFile' => [ 'type' => 'structure', 'required' => [ 'uri', ], 'members' => [ 'uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$', ], 'SearchType' => [ 'type' => 'string', 'enum' => [ 'HYBRID', 'SEMANTIC', ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SessionAttributesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SessionId' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '^[0-9a-zA-Z._:-]+$', ], 'SessionState' => [ 'type' => 'structure', 'members' => [ 'files' => [ 'shape' => 'InputFiles', ], 'invocationId' => [ 'shape' => 'String', ], 'knowledgeBaseConfigurations' => [ 'shape' => 'KnowledgeBaseConfigurations', ], 'promptSessionAttributes' => [ 'shape' => 'PromptSessionAttributesMap', ], 'returnControlInvocationResults' => [ 'shape' => 'ReturnControlInvocationResults', ], 'sessionAttributes' => [ 'shape' => 'SessionAttributesMap', ], ], ], 'Source' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'PARSER', ], 'sensitive' => true, ], 'Span' => [ 'type' => 'structure', 'members' => [ 'end' => [ 'shape' => 'SpanEndInteger', ], 'start' => [ 'shape' => 'SpanStartInteger', ], ], ], 'SpanEndInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'SpanStartInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'StopSequences' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 4, 'min' => 0, ], 'String' => [ 'type' => 'string', ], 'SummaryText' => [ 'type' => 'string', 'max' => 25000000, 'min' => 0, ], 'Temperature' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'TextInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'maxTokens' => [ 'shape' => 'MaxTokens', ], 'stopSequences' => [ 'shape' => 'RAGStopSequences', ], 'temperature' => [ 'shape' => 'Temperature', ], 'topP' => [ 'shape' => 'TopP', ], ], ], 'TextPromptTemplate' => [ 'type' => 'string', 'max' => 4000, 'min' => 1, 'sensitive' => true, ], 'TextResponsePart' => [ 'type' => 'structure', 'members' => [ 'span' => [ 'shape' => 'Span', ], 'text' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TopK' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 0, ], 'TopP' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'Trace' => [ 'type' => 'structure', 'members' => [ 'failureTrace' => [ 'shape' => 'FailureTrace', ], 'guardrailTrace' => [ 'shape' => 'GuardrailTrace', ], 'orchestrationTrace' => [ 'shape' => 'OrchestrationTrace', ], 'postProcessingTrace' => [ 'shape' => 'PostProcessingTrace', ], 'preProcessingTrace' => [ 'shape' => 'PreProcessingTrace', ], ], 'sensitive' => true, 'union' => true, ], 'TraceId' => [ 'type' => 'string', 'max' => 16, 'min' => 2, ], 'TraceKnowledgeBaseId' => [ 'type' => 'string', 'sensitive' => true, ], 'TracePart' => [ 'type' => 'structure', 'members' => [ 'agentAliasId' => [ 'shape' => 'AgentAliasId', ], 'agentId' => [ 'shape' => 'AgentId', ], 'agentVersion' => [ 'shape' => 'AgentVersion', ], 'sessionId' => [ 'shape' => 'SessionId', ], 'trace' => [ 'shape' => 'Trace', ], ], 'event' => true, 'sensitive' => true, ], 'Type' => [ 'type' => 'string', 'enum' => [ 'ACTION_GROUP', 'KNOWLEDGE_BASE', 'FINISH', 'ASK_USER', 'REPROMPT', ], ], 'Usage' => [ 'type' => 'structure', 'members' => [ 'inputTokens' => [ 'shape' => 'Integer', ], 'outputTokens' => [ 'shape' => 'Integer', ], ], 'sensitive' => true, ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Verb' => [ 'type' => 'string', 'sensitive' => true, ], ],]; diff --git a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json index 18328ce82f..7bd9b8b960 100644 --- a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json +++ b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json @@ -168,7 +168,7 @@ "base": null, "refs": { "ByteContentDoc$data": "

The byte value of the file to upload, encoded as a Base-64 string.

", - "ByteContentFile$data": "

The byte value of the file to attach, encoded as Base-64 string. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.

" + "ByteContentFile$data": "

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.

" } }, "ByteContentDoc": { diff --git a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php index 807a16564d..68821b05ad 100644 --- a/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php +++ b/src/data/bedrock-agent-runtime/2023-07-26/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Contains APIs related to model invocation and querying of knowledge bases.

', 'operations' => [ 'DeleteAgentMemory' => '

Deletes memory from the specified memory identifier.

', 'GetAgentMemory' => '

Gets the sessions stored in the memory of the agent.

', 'InvokeAgent' => '

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeAgent.

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

The response is returned in the bytes field of the chunk object.

', 'InvokeFlow' => '

Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there\'s an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeFlow.

', 'Retrieve' => '

Queries a knowledge base and retrieves information from it.

', 'RetrieveAndGenerate' => '

Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', 'refs' => [ 'FlowResponseStream$accessDeniedException' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', 'ResponseStream$accessDeniedException' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', ], ], 'ActionGroupInvocationInput' => [ 'base' => '

Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.

', 'refs' => [ 'InvocationInput$actionGroupInvocationInput' => '

Contains information about the action group to be invoked.

', ], ], 'ActionGroupInvocationOutput' => [ 'base' => '

Contains the JSON-formatted string returned by the API invoked by the action group.

', 'refs' => [ 'Observation$actionGroupInvocationOutput' => '

Contains the JSON-formatted string returned by the API invoked by the action group.

', ], ], 'ActionGroupName' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$actionGroupName' => '

The name of the action group.

', ], ], 'ActionGroupOutputString' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationOutput$text' => '

The JSON-formatted string returned by the API invoked by the action group.

', ], ], 'ActionInvocationType' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$actionInvocationType' => '

Contains information about the API operation to invoke.

', 'FunctionInvocationInput$actionInvocationType' => '

Contains information about the function to invoke,

', ], ], 'AdditionalModelRequestFields' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesGenerationConfiguration$additionalModelRequestFields' => '

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

', 'GenerationConfiguration$additionalModelRequestFields' => '

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

', ], ], 'AdditionalModelRequestFieldsKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$key' => NULL, ], ], 'AdditionalModelRequestFieldsValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$value' => NULL, ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$agentAliasId' => '

The unique identifier of an alias of an agent.

', 'GetAgentMemoryRequest$agentAliasId' => '

The unique identifier of an alias of an agent.

', 'InvokeAgentRequest$agentAliasId' => '

The alias of the agent to use.

', 'TracePart$agentAliasId' => '

The unique identifier of the alias of the agent.

', ], ], 'AgentId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$agentId' => '

The unique identifier of the agent to which the alias belongs.

', 'GetAgentMemoryRequest$agentId' => '

The unique identifier of the agent to which the alias belongs.

', 'InvokeAgentRequest$agentId' => '

The unique identifier of the agent to use.

', 'TracePart$agentId' => '

The unique identifier of the agent.

', ], ], 'AgentVersion' => [ 'base' => NULL, 'refs' => [ 'TracePart$agentVersion' => '

The version of the agent.

', ], ], 'ApiContentMap' => [ 'base' => NULL, 'refs' => [ 'ApiRequestBody$content' => '

The content of the request body. The key of the object in this field is a media type defining the format of the request body.

', ], ], 'ApiInvocationInput' => [ 'base' => '

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputMember$apiInvocationInput' => '

Contains information about the API operation that the agent predicts should be called.

', ], ], 'ApiParameter' => [ 'base' => '

Information about a parameter to provide to the API request.

This data type is used in the following API operations:

', 'refs' => [ 'ApiParameters$member' => NULL, ], ], 'ApiParameters' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$parameters' => '

The parameters to provide for the API request, as the agent elicited from the user.

', ], ], 'ApiPath' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$apiPath' => '

The path to the API to call, based off the action group.

', 'ApiInvocationInput$apiPath' => '

The path to the API operation.

', 'ApiResult$apiPath' => '

The path to the API operation.

', ], ], 'ApiRequestBody' => [ 'base' => '

The request body to provide for the API request, as the agent elicited from the user.

This data type is used in the following API operations:

', 'refs' => [ 'ApiInvocationInput$requestBody' => '

The request body to provide for the API request, as the agent elicited from the user.

', ], ], 'ApiResult' => [ 'base' => '

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationResultMember$apiResult' => '

The result from the API response from the action group invocation.

', ], ], 'Attribution' => [ 'base' => '

Contains citations for a part of an agent response.

', 'refs' => [ 'PayloadPart$attribution' => '

Contains citations for a part of an agent response.

', ], ], 'BadGatewayException' => [ 'base' => '

There was an issue with a dependency due to a server issue. Retry your request.

', 'refs' => [ 'FlowResponseStream$badGatewayException' => '

There was an issue with a dependency due to a server issue. Retry your request.

', 'ResponseStream$badGatewayException' => '

There was an issue with a dependency due to a server issue. Retry your request.

', ], ], 'BedrockModelArn' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$modelArn' => '

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn' => '

The ARN of the foundation model used to generate a response.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CodeInterpreterInvocationOutput$executionTimeout' => '

Indicates if the execution of the code timed out.

', 'InvokeAgentRequest$enableTrace' => '

Specifies whether to turn on the trace or not to track the agent\'s reasoning process. For more information, see Trace enablement.

', 'InvokeAgentRequest$endSession' => '

Specifies whether to end the session with the agent or not.

', 'PreProcessingParsedResponse$isValid' => '

Whether the user input is valid or not. If false, the agent doesn\'t proceed to orchestration.

', ], ], 'ByteContentBlob' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$data' => '

The byte value of the file to upload, encoded as a Base-64 string.

', 'ByteContentFile$data' => '

The byte value of the file to attach, encoded as Base-64 string. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.

', ], ], 'ByteContentDoc' => [ 'base' => '

This property contains the document to chat with, along with its attributes.

', 'refs' => [ 'ExternalSource$byteContent' => '

The identifier, contentType, and data of the external source wrapper object.

', ], ], 'ByteContentFile' => [ 'base' => '

The property contains the file to chat with, along with its attributes.

', 'refs' => [ 'FileSource$byteContent' => '

The data and the text of the attached files.

', ], ], 'Citation' => [ 'base' => '

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

', 'refs' => [ 'Citations$member' => NULL, ], ], 'Citations' => [ 'base' => NULL, 'refs' => [ 'Attribution$citations' => '

A list of citations and related information for a part of an agent response.

', 'RetrieveAndGenerateResponse$citations' => '

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

', ], ], 'CodeInterpreterInvocationInput' => [ 'base' => '

Contains information about the code interpreter being invoked.

', 'refs' => [ 'InvocationInput$codeInterpreterInvocationInput' => '

Contains information about the code interpreter to be invoked.

', ], ], 'CodeInterpreterInvocationOutput' => [ 'base' => '

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

', 'refs' => [ 'Observation$codeInterpreterInvocationOutput' => '

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

', ], ], 'ConfirmationState' => [ 'base' => NULL, 'refs' => [ 'ApiResult$confirmationState' => '

Controls the API operations or functions to invoke based on the user confirmation.

', 'FunctionResult$confirmationState' => '

Contains the user confirmation information about the function that was called.

', ], ], 'ConflictException' => [ 'base' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', 'refs' => [ 'FlowResponseStream$conflictException' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', 'ResponseStream$conflictException' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', ], ], 'ContentBody' => [ 'base' => '

Contains the body of the API response.

This data type is used in the following API operations:

', 'refs' => [ 'ResponseBody$value' => NULL, ], ], 'ContentMap' => [ 'base' => NULL, 'refs' => [ 'RequestBody$content' => '

The content in the request body.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$contentType' => '

The MIME type of the document contained in the wrapper object.

', ], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$parserMode' => '

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

', 'ModelInvocationInput$promptCreationMode' => '

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.

', ], ], 'DateTimestamp' => [ 'base' => '

Time Stamp.

', 'refs' => [ 'MemorySessionSummary$sessionExpiryTime' => '

The time when the memory duration for the session is set to end.

', 'MemorySessionSummary$sessionStartTime' => '

The start time for this session.

', ], ], 'DeleteAgentMemoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAgentMemoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailedException' => [ 'base' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', 'refs' => [ 'FlowResponseStream$dependencyFailedException' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', 'ResponseStream$dependencyFailedException' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', ], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'FlowInputContent$document' => '

The input to send to the prompt flow input node.

', 'FlowOutputContent$document' => '

The content in the output.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$score' => '

The level of relevance of the result to the query.

', ], ], 'ExecutionType' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$executionType' => '

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

', ], ], 'ExternalSource' => [ 'base' => '

The unique external source of the content contained in the wrapper object.

', 'refs' => [ 'ExternalSources$member' => NULL, ], ], 'ExternalSourceType' => [ 'base' => NULL, 'refs' => [ 'ExternalSource$sourceType' => '

The source type of the external source wrapper object.

', ], ], 'ExternalSources' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$sources' => '

The document used with the external source wrapper object in the retrieveAndGenerate function.

', ], ], 'ExternalSourcesGenerationConfiguration' => [ 'base' => '

Contains the generation configuration of the external source wrapper object.

', 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$generationConfiguration' => '

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

', ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'base' => '

The configurations of the external source wrapper object in the retrieveAndGenerate function.

', 'refs' => [ 'RetrieveAndGenerateConfiguration$externalSourcesConfiguration' => '

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

', ], ], 'FailureReasonString' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$failureReason' => '

The reason the interaction failed.

', ], ], 'FailureTrace' => [ 'base' => '

Contains information about the failure of the interaction.

', 'refs' => [ 'Trace$failureTrace' => '

Contains information about the failure of the interaction.

', ], ], 'FileBody' => [ 'base' => NULL, 'refs' => [ 'OutputFile$bytes' => '

The byte count of files that contains response from code interpreter.

', ], ], 'FilePart' => [ 'base' => '

Contains intermediate response for code interpreter if any files have been generated.

', 'refs' => [ 'ResponseStream$files' => '

Contains intermediate response for code interpreter if any files have been generated.

', ], ], 'FileSource' => [ 'base' => '

The source file of the content contained in the wrapper object.

', 'refs' => [ 'InputFile$source' => '

Specifies where the files are located.

', ], ], 'FileSourceType' => [ 'base' => NULL, 'refs' => [ 'FileSource$sourceType' => '

The source type of the files to attach.

', ], ], 'FileUseCase' => [ 'base' => NULL, 'refs' => [ 'InputFile$useCase' => '

Specifies how the source files will be used by the code interpreter.

', ], ], 'Files' => [ 'base' => NULL, 'refs' => [ 'CodeInterpreterInvocationInput$files' => '

Files that are uploaded for code interpreter to use.

', 'CodeInterpreterInvocationOutput$files' => '

Contains output files, if generated by code execution.

', ], ], 'FilterAttribute' => [ 'base' => '

Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievalFilter$equals' => '

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is cat:

"equals": { "key": "animal", "value": "cat" }

', 'RetrievalFilter$greaterThan' => '

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 }

', 'RetrievalFilter$greaterThanOrEquals' => '

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 }

', 'RetrievalFilter$in' => '

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"] }

', 'RetrievalFilter$lessThan' => '

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 }

', 'RetrievalFilter$lessThanOrEquals' => '

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 }

', 'RetrievalFilter$listContains' => '

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" }

', 'RetrievalFilter$notEquals' => '

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn\'t match the value in this object are returned.

The following example would return data sources that don\'t contain an animal attribute whose value is cat.

"notEquals": { "key": "animal", "value": "cat" }

', 'RetrievalFilter$notIn' => '

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"] }

', 'RetrievalFilter$startsWith' => '

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" }

', 'RetrievalFilter$stringContains' => '

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:

', ], ], 'FilterKey' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$key' => '

The name that the metadata attribute must match.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$value' => '

The value to whcih to compare the value of the metadata attribute.

', ], ], 'FinalResponse' => [ 'base' => '

Contains details about the response to the user.

', 'refs' => [ 'Observation$finalResponse' => '

Contains details about the response to the user.

', ], ], 'FinalResponseString' => [ 'base' => NULL, 'refs' => [ 'FinalResponse$text' => '

The text in the response to the user.

', ], ], 'FlowAliasIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$flowAliasIdentifier' => '

The unique identifier of the flow alias.

', ], ], 'FlowCompletionEvent' => [ 'base' => '

Contains information about why a flow completed.

This data type is used in the following API operations:

', 'refs' => [ 'FlowResponseStream$flowCompletionEvent' => '

Contains information about why the flow completed.

', ], ], 'FlowCompletionReason' => [ 'base' => NULL, 'refs' => [ 'FlowCompletionEvent$completionReason' => '

The reason that the flow completed.

', ], ], 'FlowIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$flowIdentifier' => '

The unique identifier of the flow.

', ], ], 'FlowInput' => [ 'base' => '

Contains information about an input into the prompt flow and where to send it.

This data type is used in the following API operations:

', 'refs' => [ 'FlowInputs$member' => NULL, ], ], 'FlowInputContent' => [ 'base' => '

Contains information about an input into the flow.

This data type is used in the following API operations:

', 'refs' => [ 'FlowInput$content' => '

Contains information about an input into the prompt flow.

', ], ], 'FlowInputs' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$inputs' => '

A list of objects, each containing information about an input into the flow.

', ], ], 'FlowOutputContent' => [ 'base' => '

Contains information about the content in an output from prompt flow invocation.

This data type is used in the following API operations:

', 'refs' => [ 'FlowOutputEvent$content' => '

The content in the output.

', ], ], 'FlowOutputEvent' => [ 'base' => '

Contains information about an output from prompt flow invoction.

This data type is used in the following API operations:

', 'refs' => [ 'FlowResponseStream$flowOutputEvent' => '

Contains information about an output from flow invocation.

', ], ], 'FlowResponseStream' => [ 'base' => '

The output of the flow.

This data type is used in the following API operations:

', 'refs' => [ 'InvokeFlowResponse$responseStream' => '

The output of the flow, returned as a stream. If there\'s an error, the error is returned.

', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$function' => '

The function in the action group to call.

', ], ], 'FunctionInvocationInput' => [ 'base' => '

Contains information about the function that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputMember$functionInvocationInput' => '

Contains information about the function that the agent predicts should be called.

', ], ], 'FunctionParameter' => [ 'base' => '

Contains information about a parameter of the function.

This data type is used in the following API operations:

', 'refs' => [ 'FunctionParameters$member' => NULL, ], ], 'FunctionParameters' => [ 'base' => NULL, 'refs' => [ 'FunctionInvocationInput$parameters' => '

A list of parameters of the function.

', ], ], 'FunctionResult' => [ 'base' => '

Contains information about the function that was called from the action group and the response that was returned.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationResultMember$functionResult' => '

The result from the function from the action group invocation.

', ], ], 'GeneratedResponsePart' => [ 'base' => '

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

', 'refs' => [ 'Citation$generatedResponsePart' => '

Contains the generated response and metadata

', ], ], 'GenerationConfiguration' => [ 'base' => '

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration' => '

Contains configurations for response generation based on the knowledge base query results.

', ], ], 'GetAgentMemoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentMemoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GuadrailAction' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateResponse$guardrailAction' => '

Specifies if there is a guardrail intervention in the response.

', ], ], 'GuardrailAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$action' => '

The trace action details used with the Guardrail.

', ], ], 'GuardrailAssessment' => [ 'base' => '

Assessment details of the content analyzed by Guardrails.

', 'refs' => [ 'GuardrailAssessmentList$member' => NULL, ], ], 'GuardrailAssessmentList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$inputAssessments' => '

The details of the input assessments used in the Guardrail Trace.

', 'GuardrailTrace$outputAssessments' => '

The details of the output assessments used in the Guardrail Trace.

', ], ], 'GuardrailConfiguration' => [ 'base' => '

The configuration details for the guardrail.

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$guardrailConfiguration' => '

The configuration details for the guardrail.

', 'GenerationConfiguration$guardrailConfiguration' => '

The configuration details for the guardrail.

', ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailId' => '

The unique identifier for the guardrail.

', ], ], 'GuardrailConfigurationGuardrailVersionString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailVersion' => '

The version of the guardrail.

', ], ], 'GuardrailContentFilter' => [ 'base' => '

Details of the content filter used in the Guardrail.

', 'refs' => [ 'GuardrailContentFilterList$member' => NULL, ], ], 'GuardrailContentFilterConfidence' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$confidence' => '

The confidence level regarding the content detected in the filter by the Guardrail.

', ], ], 'GuardrailContentFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentPolicyAssessment$filters' => '

The filter details of the policy assessment used in the Guardrails filter.

', ], ], 'GuardrailContentFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$type' => '

The type of content detected in the filter by the Guardrail.

', ], ], 'GuardrailContentPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$action' => '

The action placed on the content by the Guardrail filter.

', ], ], 'GuardrailContentPolicyAssessment' => [ 'base' => '

The details of the policy assessment in the Guardrails filter.

', 'refs' => [ 'GuardrailAssessment$contentPolicy' => '

Content policy details of the Guardrail.

', ], ], 'GuardrailCustomWord' => [ 'base' => '

The custom word details for the filter in the Guardrail.

', 'refs' => [ 'GuardrailCustomWordList$member' => NULL, ], ], 'GuardrailCustomWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$customWords' => '

The custom word details for words defined in the Guardrail filter.

', ], ], 'GuardrailManagedWord' => [ 'base' => '

The managed word details for the filter in the Guardrail.

', 'refs' => [ 'GuardrailManagedWordList$member' => NULL, ], ], 'GuardrailManagedWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$managedWordLists' => '

The managed word lists for words defined in the Guardrail filter.

', ], ], 'GuardrailManagedWordType' => [ 'base' => NULL, 'refs' => [ 'GuardrailManagedWord$type' => '

The type details for the managed word filter in the Guardrail.

', ], ], 'GuardrailPiiEntityFilter' => [ 'base' => '

The Guardrail filter to identify and remove personally identifiable information (PII).

', 'refs' => [ 'GuardrailPiiEntityFilterList$member' => NULL, ], ], 'GuardrailPiiEntityFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$piiEntities' => '

The details of the PII entities used in the sensitive policy assessment for the Guardrail.

', ], ], 'GuardrailPiiEntityType' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$type' => '

The type of PII the Guardrail filter has identified and removed.

', ], ], 'GuardrailRegexFilter' => [ 'base' => '

The details for the regex filter used in the Guardrail.

', 'refs' => [ 'GuardrailRegexFilterList$member' => NULL, ], ], 'GuardrailRegexFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$regexes' => '

The details of the regexes used in the sensitive policy assessment for the Guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$action' => '

The action of the Guardrail filter to identify and remove PII.

', 'GuardrailRegexFilter$action' => '

The action details for the regex filter used in the Guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'base' => '

The details of the sensitive policy assessment used in the Guardrail.

', 'refs' => [ 'GuardrailAssessment$sensitiveInformationPolicy' => '

Sensitive Information policy details of Guardrail.

', ], ], 'GuardrailTopic' => [ 'base' => '

The details for a specific topic defined in the Guardrail.

', 'refs' => [ 'GuardrailTopicList$member' => NULL, ], ], 'GuardrailTopicList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopicPolicyAssessment$topics' => '

The topic details of the policy assessment used in the Guardrail.

', ], ], 'GuardrailTopicPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$action' => '

The action details on a specific topic in the Guardrail.

', ], ], 'GuardrailTopicPolicyAssessment' => [ 'base' => '

The details of the policy assessment used in the Guardrail.

', 'refs' => [ 'GuardrailAssessment$topicPolicy' => '

Topic policy details of the Guardrail.

', ], ], 'GuardrailTopicType' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$type' => '

The type details on a specific topic in the Guardrail.

', ], ], 'GuardrailTrace' => [ 'base' => '

The trace details used in the Guardrail.

', 'refs' => [ 'Trace$guardrailTrace' => '

The trace details for a trace defined in the Guardrail filter.

', ], ], 'GuardrailWordPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailCustomWord$action' => '

The action details for the custom word filter in the Guardrail.

', 'GuardrailManagedWord$action' => '

The action details for the managed word filter in the Guardrail.

', ], ], 'GuardrailWordPolicyAssessment' => [ 'base' => '

The assessment details for words defined in the Guardrail filter.

', 'refs' => [ 'GuardrailAssessment$wordPolicy' => '

Word policy details of the Guardrail.

', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$identifier' => '

The file name of the document contained in the wrapper object.

', ], ], 'InferenceConfig' => [ 'base' => '

The configuration for inference settings when generating responses using RetrieveAndGenerate.

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$inferenceConfig' => '

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

', 'GenerationConfiguration$inferenceConfig' => '

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

', ], ], 'InferenceConfiguration' => [ 'base' => '

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

', 'refs' => [ 'ModelInvocationInput$inferenceConfiguration' => '

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

', ], ], 'InputFile' => [ 'base' => '

Contains details of the source files.

', 'refs' => [ 'InputFiles$member' => NULL, ], ], 'InputFiles' => [ 'base' => NULL, 'refs' => [ 'SessionState$files' => '

Contains information about the files used by code interpreter.

', ], ], 'InputText' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$inputText' => '

The prompt text to send the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ApiResult$httpStatusCode' => '

http status code from API execution response (for example: 200, 400, 500).

', 'Usage$inputTokens' => '

Contains information about the input tokens from the foundation model usage.

', 'Usage$outputTokens' => '

Contains information about the output tokens from the foundation model usage.

', ], ], 'InternalServerException' => [ 'base' => '

An internal server error occurred. Retry your request.

', 'refs' => [ 'FlowResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', 'ResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', ], ], 'InvocationInput' => [ 'base' => '

Contains information pertaining to the action group or knowledge base that is being invoked.

', 'refs' => [ 'OrchestrationTrace$invocationInput' => '

Contains information pertaining to the action group or knowledge base that is being invoked.

', ], ], 'InvocationInputMember' => [ 'base' => '

Contains details about the API operation or function that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputs$member' => NULL, ], ], 'InvocationInputs' => [ 'base' => NULL, 'refs' => [ 'ReturnControlPayload$invocationInputs' => '

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

', ], ], 'InvocationResultMember' => [ 'base' => '

A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.

This data type is used in the following API operations:

', 'refs' => [ 'ReturnControlInvocationResults$member' => NULL, ], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationInput$invocationType' => '

Specifies whether the agent is invoking an action group or a knowledge base.

', ], ], 'InvokeAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InvokeFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateSessionConfiguration$kmsKeyArn' => '

The ARN of the KMS key encrypting the session.

', ], ], 'KnowledgeBaseConfiguration' => [ 'base' => '

Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.

', 'refs' => [ 'KnowledgeBaseConfigurations$member' => NULL, ], ], 'KnowledgeBaseConfigurations' => [ 'base' => NULL, 'refs' => [ 'SessionState$knowledgeBaseConfigurations' => '

An array of configurations, each of which applies to a knowledge base attached to the agent.

', ], ], 'KnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseConfiguration$knowledgeBaseId' => '

The unique identifier for a knowledge base attached to the agent.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$knowledgeBaseId' => '

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

', 'RetrieveRequest$knowledgeBaseId' => '

The unique identifier of the knowledge base to query.

', ], ], 'KnowledgeBaseLookupInput' => [ 'base' => '

Contains details about the knowledge base to look up and the query to be made.

', 'refs' => [ 'InvocationInput$knowledgeBaseLookupInput' => '

Contains details about the knowledge base to look up and the query to be made.

', ], ], 'KnowledgeBaseLookupInputString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$text' => '

The query made to the knowledge base.

', ], ], 'KnowledgeBaseLookupOutput' => [ 'base' => '

Contains details about the results from looking up the knowledge base.

', 'refs' => [ 'Observation$knowledgeBaseLookupOutput' => '

Contains details about the results from looking up the knowledge base.

', ], ], 'KnowledgeBaseQuery' => [ 'base' => '

Contains the query made to the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveRequest$retrievalQuery' => '

Contains the query to send the knowledge base.

', ], ], 'KnowledgeBaseQueryTextString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseQuery$text' => '

The text of the query made to the knowledge base.

', ], ], 'KnowledgeBaseRetrievalConfiguration' => [ 'base' => '

Contains configurations for knowledge base query. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseConfiguration$retrievalConfiguration' => '

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$retrievalConfiguration' => '

Contains configurations for how to retrieve and return the knowledge base query.

', 'RetrieveRequest$retrievalConfiguration' => '

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

', ], ], 'KnowledgeBaseRetrievalResult' => [ 'base' => '

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResults$member' => NULL, ], ], 'KnowledgeBaseRetrievalResults' => [ 'base' => NULL, 'refs' => [ 'RetrieveResponse$retrievalResults' => '

A list of results from querying the knowledge base.

', ], ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'base' => '

Contains details about the resource being queried.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateConfiguration$knowledgeBaseConfiguration' => '

Contains details about the resource being queried.

', ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'base' => '

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalConfiguration$vectorSearchConfiguration' => '

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

', ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$numberOfResults' => '

The number of source chunks to retrieve.

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$overrideLambda' => '

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

', ], ], 'MaxResults' => [ 'base' => '

Max Results.

', 'refs' => [ 'GetAgentMemoryRequest$maxItems' => '

The maximum number of items 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.

', ], ], 'MaxTokens' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$maxTokens' => '

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maximumLength' => '

The maximum number of tokens allowed in the generated response.

', ], ], 'Memories' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryResponse$memoryContents' => '

Contains details of the sessions stored in the memory

', ], ], 'Memory' => [ 'base' => '

Contains sessions summaries.

', 'refs' => [ 'Memories$member' => NULL, ], ], 'MemoryId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$memoryId' => '

The unique identifier of the memory.

', 'GetAgentMemoryRequest$memoryId' => '

The unique identifier of the memory.

', 'InvokeAgentRequest$memoryId' => '

The unique identifier of the agent memory.

', 'InvokeAgentResponse$memoryId' => '

The unique identifier of the agent memory.

', 'MemorySessionSummary$memoryId' => '

The unique identifier of the memory where the session summary is stored.

', ], ], 'MemorySessionSummary' => [ 'base' => '

Contains details of a session summary.

', 'refs' => [ 'Memory$sessionSummary' => '

Contains summary of a session.

', ], ], 'MemoryType' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryRequest$memoryType' => '

The type of memory.

', ], ], 'Metadata' => [ 'base' => '

Provides details of the foundation model.

', 'refs' => [ 'OrchestrationModelInvocationOutput$metadata' => '

Contains information about the foundation model output.

', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'ByteContentFile$mediaType' => '

The MIME type of data contained in the file used for chat.

', 'InvokeAgentResponse$contentType' => '

The MIME type of the input data in the request. The default value is application/json.

', 'OutputFile$type' => '

The type of file that contains response from the code interpreter.

', ], ], 'ModelInvocationInput' => [ 'base' => '

The input for the pre-processing step.

', 'refs' => [ 'OrchestrationTrace$modelInvocationInput' => '

The input for the orchestration step.

', 'PostProcessingTrace$modelInvocationInput' => '

The input for the post-processing step.

', 'PreProcessingTrace$modelInvocationInput' => '

The input for the pre-processing step.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryRequest$nextToken' => '

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.

', 'GetAgentMemoryResponse$nextToken' => '

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.

', 'RetrieveRequest$nextToken' => '

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.

', 'RetrieveResponse$nextToken' => '

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.

', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'FlowInput$nodeName' => '

The name of the flow input node that begins the prompt flow.

', 'FlowOutputEvent$nodeName' => '

The name of the flow output node that the output is from.

', ], ], 'NodeOutputName' => [ 'base' => NULL, 'refs' => [ 'FlowInput$nodeOutputName' => '

The name of the output from the flow input node that begins the prompt flow.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'FlowOutputEvent$nodeType' => '

The type of the node that the output is from.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BadGatewayException$message' => NULL, 'BadGatewayException$resourceName' => '

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

', 'ConflictException$message' => NULL, 'DependencyFailedException$message' => NULL, 'DependencyFailedException$resourceName' => '

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

', 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'Observation' => [ 'base' => '

Contains the result or output of an action group or knowledge base, or the response to the user.

', 'refs' => [ 'OrchestrationTrace$observation' => '

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

', ], ], 'OrchestrationConfiguration' => [ 'base' => '

Settings for how the model processes the prompt prior to retrieval and generation.

', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$orchestrationConfiguration' => '

Settings for how the model processes the prompt prior to retrieval and generation.

', ], ], 'OrchestrationModelInvocationOutput' => [ 'base' => '

The foundation model output from the orchestration step.

', 'refs' => [ 'OrchestrationTrace$modelInvocationOutput' => '

Contains information pertaining to the output from the foundation model that is being invoked.

', ], ], 'OrchestrationTrace' => [ 'base' => '

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

', 'refs' => [ 'Trace$orchestrationTrace' => '

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

', ], ], 'OutputFile' => [ 'base' => '

Contains details of the response from code interpreter.

', 'refs' => [ 'OutputFiles$member' => NULL, ], ], 'OutputFiles' => [ 'base' => NULL, 'refs' => [ 'FilePart$files' => '

Files containing intermediate response for the user.

', ], ], 'OutputString' => [ 'base' => NULL, 'refs' => [ 'PostProcessingParsedResponse$text' => '

The text returned by the parser.

', ], ], 'Parameter' => [ 'base' => '

A parameter for the API request or function.

', 'refs' => [ 'ParameterList$member' => NULL, 'Parameters$member' => NULL, ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'PropertyParameters$properties' => '

A list of parameters in the request body.

', ], ], 'Parameters' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$parameters' => '

The parameters in the Lambda input event.

', 'ContentMap$value' => NULL, ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => '

A part of the agent response in bytes.

', ], ], 'PayloadPart' => [ 'base' => '

Contains a part of an agent response and citations for it.

', 'refs' => [ 'ResponseStream$chunk' => '

Contains a part of an agent response and citations for it.

', ], ], 'PostProcessingModelInvocationOutput' => [ 'base' => '

The foundation model output from the post-processing step.

', 'refs' => [ 'PostProcessingTrace$modelInvocationOutput' => '

The foundation model output from the post-processing step.

', ], ], 'PostProcessingParsedResponse' => [ 'base' => '

Details about the response from the Lambda parsing of the output from the post-processing step.

', 'refs' => [ 'PostProcessingModelInvocationOutput$parsedResponse' => '

Details about the response from the Lambda parsing of the output of the post-processing step.

', ], ], 'PostProcessingTrace' => [ 'base' => '

Details about the post-processing step, in which the agent shapes the response.

', 'refs' => [ 'Trace$postProcessingTrace' => '

Details about the post-processing step, in which the agent shapes the response..

', ], ], 'PreProcessingModelInvocationOutput' => [ 'base' => '

The foundation model output from the pre-processing step.

', 'refs' => [ 'PreProcessingTrace$modelInvocationOutput' => '

The foundation model output from the pre-processing step.

', ], ], 'PreProcessingParsedResponse' => [ 'base' => '

Details about the response from the Lambda parsing of the output from the pre-processing step.

', 'refs' => [ 'PreProcessingModelInvocationOutput$parsedResponse' => '

Details about the response from the Lambda parsing of the output of the pre-processing step.

', ], ], 'PreProcessingTrace' => [ 'base' => '

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

', 'refs' => [ 'Trace$preProcessingTrace' => '

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

', ], ], 'PromptSessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$promptSessionAttributes' => '

Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.

', ], ], 'PromptTemplate' => [ 'base' => '

Contains the template for the prompt that\'s sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$promptTemplate' => '

Contain the textPromptTemplate string for the external source wrapper object.

', 'GenerationConfiguration$promptTemplate' => '

Contains the template for the prompt that\'s sent to the model for response generation.

', ], ], 'PromptText' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$text' => '

The text that prompted the agent at this step.

', ], ], 'PromptType' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$type' => '

The step in the agent sequence.

', ], ], 'PropertyParameters' => [ 'base' => '

Contains the parameters in the request body.

', 'refs' => [ 'ApiContentMap$value' => NULL, ], ], 'QueryTransformationConfiguration' => [ 'base' => '

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

', 'refs' => [ 'OrchestrationConfiguration$queryTransformationConfiguration' => '

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

', ], ], 'QueryTransformationType' => [ 'base' => NULL, 'refs' => [ 'QueryTransformationConfiguration$type' => '

The type of transformation to apply to the prompt.

', ], ], 'RAGStopSequences' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$stopSequences' => '

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

', ], ], 'RAGStopSequencesMemberString' => [ 'base' => NULL, 'refs' => [ 'RAGStopSequences$member' => NULL, ], ], 'Rationale' => [ 'base' => '

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

', 'refs' => [ 'OrchestrationTrace$rationale' => '

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

', ], ], 'RationaleString' => [ 'base' => NULL, 'refs' => [ 'PreProcessingParsedResponse$rationale' => '

The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.

', 'Rationale$text' => '

The reasoning or thought process of the agent, based on the input.

', ], ], 'RawResponse' => [ 'base' => '

Contains the raw output from the foundation model.

', 'refs' => [ 'OrchestrationModelInvocationOutput$rawResponse' => '

Contains details of the raw response from the foundation model output.

', ], ], 'RepromptResponse' => [ 'base' => '

Contains details about the agent\'s response to reprompt the input.

', 'refs' => [ 'Observation$repromptResponse' => '

Contains details about the response to reprompt the input.

', ], ], 'RequestBody' => [ 'base' => '

The parameters in the API request body.

', 'refs' => [ 'ActionGroupInvocationInput$requestBody' => '

The parameters in the request body for the Lambda input event.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', 'refs' => [ 'FlowResponseStream$resourceNotFoundException' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', 'ResponseStream$resourceNotFoundException' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', ], ], 'ResponseBody' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseBody' => '

The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

', 'FunctionResult$responseBody' => '

The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

', ], ], 'ResponseState' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseState' => '

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

', 'FunctionResult$responseState' => '

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

', ], ], 'ResponseStream' => [ 'base' => '

The response from invoking the agent and associated citations and trace information.

', 'refs' => [ 'InvokeAgentResponse$completion' => '

The agent\'s response to the user prompt.

', ], ], 'RetrievalFilter' => [ 'base' => '

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$filter' => '

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

', 'RetrievalFilterList$member' => NULL, ], ], 'RetrievalFilterList' => [ 'base' => NULL, 'refs' => [ 'RetrievalFilter$andAll' => '

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

', 'RetrievalFilter$orAll' => '

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

', ], ], 'RetrievalResultConfluenceLocation' => [ 'base' => '

The Confluence data source location.

', 'refs' => [ 'RetrievalResultLocation$confluenceLocation' => '

The Confluence data source location.

', ], ], 'RetrievalResultContent' => [ 'base' => '

Contains the cited text from the data source.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResult$content' => '

Contains a chunk of text from a data source in the knowledge base.

', 'RetrievedReference$content' => '

Contains the cited text from the data source.

', ], ], 'RetrievalResultLocation' => [ 'base' => '

Contains information about the data source location.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResult$location' => '

Contains information about the location of the data source.

', 'RetrievedReference$location' => '

Contains information about the location of the data source.

', ], ], 'RetrievalResultLocationType' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultLocation$type' => '

The type of data source location.

', ], ], 'RetrievalResultMetadata' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$metadata' => '

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

', 'RetrievedReference$metadata' => '

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

', ], ], 'RetrievalResultMetadataKey' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$key' => NULL, ], ], 'RetrievalResultMetadataValue' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$value' => NULL, ], ], 'RetrievalResultS3Location' => [ 'base' => '

The S3 data source location.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievalResultLocation$s3Location' => '

The S3 data source location.

', ], ], 'RetrievalResultSalesforceLocation' => [ 'base' => '

The Salesforce data source location.

', 'refs' => [ 'RetrievalResultLocation$salesforceLocation' => '

The Salesforce data source location.

', ], ], 'RetrievalResultSharePointLocation' => [ 'base' => '

The SharePoint data source location.

', 'refs' => [ 'RetrievalResultLocation$sharePointLocation' => '

The SharePoint data source location.

', ], ], 'RetrievalResultWebLocation' => [ 'base' => '

The web URL/URLs data source location.

', 'refs' => [ 'RetrievalResultLocation$webLocation' => '

The web URL/URLs data source location.

', ], ], 'RetrieveAndGenerateConfiguration' => [ 'base' => '

Contains details about the resource being queried.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$retrieveAndGenerateConfiguration' => '

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

', ], ], 'RetrieveAndGenerateInput' => [ 'base' => '

Contains the query made to the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$input' => '

Contains the query to be made to the knowledge base.

', ], ], 'RetrieveAndGenerateInputTextString' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateInput$text' => '

The query made to the knowledge base.

', ], ], 'RetrieveAndGenerateOutput' => [ 'base' => '

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateResponse$output' => '

Contains the response generated from querying the knowledge base.

', ], ], 'RetrieveAndGenerateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'base' => '

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$sessionConfiguration' => '

Contains details about the session with the knowledge base.

', ], ], 'RetrieveAndGenerateType' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateConfiguration$type' => '

The type of resource that is queried by the request.

', ], ], 'RetrieveRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrievedReference' => [ 'base' => '

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievedReferences$member' => NULL, ], ], 'RetrievedReferences' => [ 'base' => NULL, 'refs' => [ 'Citation$retrievedReferences' => '

Contains metadata about the sources cited for the generated response.

', 'KnowledgeBaseLookupOutput$retrievedReferences' => '

Contains metadata about the sources cited for the generated response.

', ], ], 'ReturnControlInvocationResults' => [ 'base' => NULL, 'refs' => [ 'SessionState$returnControlInvocationResults' => '

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

', ], ], 'ReturnControlPayload' => [ 'base' => '

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the following API operations:

', 'refs' => [ 'ResponseStream$returnControl' => '

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

', ], ], 'S3ObjectDoc' => [ 'base' => '

The unique wrapper object of the document from the S3 location.

', 'refs' => [ 'ExternalSource$s3Location' => '

The S3 location of the external source wrapper object.

', ], ], 'S3ObjectFile' => [ 'base' => '

Contains details of the s3 object where the source file is located.

', 'refs' => [ 'FileSource$s3Location' => '

The s3 location of the files to attach.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'S3ObjectDoc$uri' => '

The file location of the S3 wrapper object.

', 'S3ObjectFile$uri' => '

The uri of the s3 object.

', ], ], 'SearchType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$overrideSearchType' => '

By default, Amazon Bedrock decides a search strategy for you. If you\'re using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

The number of requests exceeds the service quota. Resubmit your request later.

', 'refs' => [ 'FlowResponseStream$serviceQuotaExceededException' => '

The number of requests exceeds the service quota. Resubmit your request later.

', 'ResponseStream$serviceQuotaExceededException' => '

The number of requests exceeds the service quota. Resubmit your request later.

', ], ], 'SessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$sessionAttributes' => '

Contains attributes that persist across a session and the values of those attributes.

', ], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$sessionId' => '

The unique identifier of the session. Use the same value across requests to continue the same conversation.

', 'InvokeAgentResponse$sessionId' => '

The unique identifier of the session with the agent.

', 'MemorySessionSummary$sessionId' => '

The identifier for this session.

', 'RetrieveAndGenerateRequest$sessionId' => '

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.

', 'RetrieveAndGenerateResponse$sessionId' => '

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.

', 'TracePart$sessionId' => '

The unique identifier of the session with the agent.

', ], ], 'SessionState' => [ 'base' => '

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent\'s behavior. For more information, see Control session context.

', 'refs' => [ 'InvokeAgentRequest$sessionState' => '

Contains parameters that specify various attributes of the session. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

', ], ], 'Source' => [ 'base' => NULL, 'refs' => [ 'RepromptResponse$source' => '

Specifies what output is prompting the agent to reprompt the input.

', ], ], 'Span' => [ 'base' => '

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

', 'refs' => [ 'TextResponsePart$span' => '

Contains information about where the text with a citation begins and ends in the generated output.

', ], ], 'SpanEndInteger' => [ 'base' => NULL, 'refs' => [ 'Span$end' => '

Where the text with a citation ends in the generated output.

', ], ], 'SpanStartInteger' => [ 'base' => NULL, 'refs' => [ 'Span$start' => '

Where the text with a citation starts in the generated output.

', ], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => '

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$invocationId' => '

The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

', 'ApiContentMap$key' => NULL, 'ApiInvocationInput$actionGroup' => '

The action group that the API operation belongs to.

', 'ApiInvocationInput$httpMethod' => '

The HTTP method of the API operation.

', 'ApiParameter$name' => '

The name of the parameter.

', 'ApiParameter$type' => '

The data type for the parameter.

', 'ApiParameter$value' => '

The value of the parameter.

', 'ApiResult$actionGroup' => '

The action group that the API operation belongs to.

', 'ApiResult$httpMethod' => '

The HTTP method for the API operation.

', 'CodeInterpreterInvocationInput$code' => '

The code for the code interpreter to use.

', 'CodeInterpreterInvocationOutput$executionError' => '

Contains the error returned from code execution.

', 'CodeInterpreterInvocationOutput$executionOutput' => '

Contains the successful output returned from code execution

', 'ContentBody$body' => '

The body of the API response.

', 'ContentMap$key' => NULL, 'Files$member' => NULL, 'FunctionInvocationInput$actionGroup' => '

The action group that the function belongs to.

', 'FunctionInvocationInput$function' => '

The name of the function.

', 'FunctionParameter$name' => '

The name of the parameter.

', 'FunctionParameter$type' => '

The data type of the parameter.

', 'FunctionParameter$value' => '

The value of the parameter.

', 'FunctionResult$actionGroup' => '

The action group that the function belongs to.

', 'FunctionResult$function' => '

The name of the function that was called.

', 'GuardrailCustomWord$match' => '

The match details for the custom word filter in the Guardrail.

', 'GuardrailManagedWord$match' => '

The match details for the managed word filter in the Guardrail.

', 'GuardrailPiiEntityFilter$match' => '

The match to settings in the Guardrail filter to identify and remove PII.

', 'GuardrailRegexFilter$match' => '

The match details for the regex filter used in the Guardrail.

', 'GuardrailRegexFilter$name' => '

The name details for the regex filter used in the Guardrail.

', 'GuardrailRegexFilter$regex' => '

The regex details for the regex filter used in the Guardrail.

', 'GuardrailTopic$name' => '

The name details on a specific topic in the Guardrail.

', 'InputFile$name' => '

The name of the source file.

', 'OutputFile$name' => '

The name of the file containing response from code interpreter.

', 'Parameter$name' => '

The name of the parameter.

', 'Parameter$type' => '

The type of the parameter.

', 'Parameter$value' => '

The value of the parameter.

', 'PromptSessionAttributesMap$key' => NULL, 'PromptSessionAttributesMap$value' => NULL, 'RawResponse$content' => '

The foundation model\'s raw output content.

', 'RepromptResponse$text' => '

The text reprompting the input.

', 'ResponseBody$key' => NULL, 'RetrievalResultConfluenceLocation$url' => '

The Confluence host URL for the data source location.

', 'RetrievalResultContent$text' => '

The cited text from the data source.

', 'RetrievalResultS3Location$uri' => '

The S3 URI for the data source location.

', 'RetrievalResultSalesforceLocation$url' => '

The Salesforce host URL for the data source location.

', 'RetrievalResultSharePointLocation$url' => '

The SharePoint site URL for the data source location.

', 'RetrievalResultWebLocation$url' => '

The web URL/URLs for the data source location.

', 'RetrieveAndGenerateOutput$text' => '

The response generated from querying the knowledge base.

', 'ReturnControlPayload$invocationId' => '

The identifier of the action group invocation.

', 'SessionAttributesMap$key' => NULL, 'SessionAttributesMap$value' => NULL, 'SessionState$invocationId' => '

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

', 'StopSequences$member' => NULL, 'TextResponsePart$text' => '

The part of the generated text that contains a citation.

', ], ], 'SummaryText' => [ 'base' => NULL, 'refs' => [ 'MemorySessionSummary$summaryText' => '

The summarized text for this session.

', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => '

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

', 'TextInferenceConfig$temperature' => '

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

', ], ], 'TextInferenceConfig' => [ 'base' => '

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model\'s inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.

', 'refs' => [ 'InferenceConfig$textInferenceConfig' => '

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

', ], ], 'TextPromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptTemplate$textPromptTemplate' => '

The template for the prompt that\'s sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

', ], ], 'TextResponsePart' => [ 'base' => '

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

', 'refs' => [ 'GeneratedResponsePart$textResponsePart' => '

Contains metadata about a textual part of the generated response that is accompanied by a citation.

', ], ], 'ThrottlingException' => [ 'base' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'refs' => [ 'FlowResponseStream$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'ResponseStream$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', ], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => '

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

', ], ], 'TopP' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topP' => '

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.

', 'TextInferenceConfig$topP' => '

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

', ], ], 'Trace' => [ 'base' => '

Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', 'refs' => [ 'TracePart$trace' => '

Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', ], ], 'TraceId' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$traceId' => '

The unique identifier of the trace.

', 'GuardrailTrace$traceId' => '

The details of the trace Id used in the Guardrail Trace.

', 'InvocationInput$traceId' => '

The unique identifier of the trace.

', 'ModelInvocationInput$traceId' => '

The unique identifier of the trace.

', 'Observation$traceId' => '

The unique identifier of the trace.

', 'OrchestrationModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'PostProcessingModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'PreProcessingModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'Rationale$traceId' => '

The unique identifier of the trace step.

', ], ], 'TraceKnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$knowledgeBaseId' => '

The unique identifier of the knowledge base to look up.

', ], ], 'TracePart' => [ 'base' => '

Contains information about the agent and session, alongside the agent\'s reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', 'refs' => [ 'ResponseStream$trace' => '

Contains information about the agent and session, alongside the agent\'s reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Observation$type' => '

Specifies what kind of information the agent returns in the observation. The following values are possible.

', ], ], 'Usage' => [ 'base' => '

Contains information of the usage of the foundation model.

', 'refs' => [ 'Metadata$usage' => '

Contains details of the foundation model usage.

', ], ], 'ValidationException' => [ 'base' => '

Input validation failed. Check your request parameters and retry the request.

', 'refs' => [ 'FlowResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', 'ResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', ], ], 'Verb' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$verb' => '

The API method being used, based off the action group.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

Contains APIs related to model invocation and querying of knowledge bases.

', 'operations' => [ 'DeleteAgentMemory' => '

Deletes memory from the specified memory identifier.

', 'GetAgentMemory' => '

Gets the sessions stored in the memory of the agent.

', 'InvokeAgent' => '

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeAgent.

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

The response is returned in the bytes field of the chunk object.

', 'InvokeFlow' => '

Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there\'s an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeFlow.

', 'Retrieve' => '

Queries a knowledge base and retrieves information from it.

', 'RetrieveAndGenerate' => '

Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', 'refs' => [ 'FlowResponseStream$accessDeniedException' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', 'ResponseStream$accessDeniedException' => '

The request is denied because of missing access permissions. Check your permissions and retry your request.

', ], ], 'ActionGroupInvocationInput' => [ 'base' => '

Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.

', 'refs' => [ 'InvocationInput$actionGroupInvocationInput' => '

Contains information about the action group to be invoked.

', ], ], 'ActionGroupInvocationOutput' => [ 'base' => '

Contains the JSON-formatted string returned by the API invoked by the action group.

', 'refs' => [ 'Observation$actionGroupInvocationOutput' => '

Contains the JSON-formatted string returned by the API invoked by the action group.

', ], ], 'ActionGroupName' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$actionGroupName' => '

The name of the action group.

', ], ], 'ActionGroupOutputString' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationOutput$text' => '

The JSON-formatted string returned by the API invoked by the action group.

', ], ], 'ActionInvocationType' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$actionInvocationType' => '

Contains information about the API operation to invoke.

', 'FunctionInvocationInput$actionInvocationType' => '

Contains information about the function to invoke,

', ], ], 'AdditionalModelRequestFields' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesGenerationConfiguration$additionalModelRequestFields' => '

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

', 'GenerationConfiguration$additionalModelRequestFields' => '

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

', ], ], 'AdditionalModelRequestFieldsKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$key' => NULL, ], ], 'AdditionalModelRequestFieldsValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalModelRequestFields$value' => NULL, ], ], 'AgentAliasId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$agentAliasId' => '

The unique identifier of an alias of an agent.

', 'GetAgentMemoryRequest$agentAliasId' => '

The unique identifier of an alias of an agent.

', 'InvokeAgentRequest$agentAliasId' => '

The alias of the agent to use.

', 'TracePart$agentAliasId' => '

The unique identifier of the alias of the agent.

', ], ], 'AgentId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$agentId' => '

The unique identifier of the agent to which the alias belongs.

', 'GetAgentMemoryRequest$agentId' => '

The unique identifier of the agent to which the alias belongs.

', 'InvokeAgentRequest$agentId' => '

The unique identifier of the agent to use.

', 'TracePart$agentId' => '

The unique identifier of the agent.

', ], ], 'AgentVersion' => [ 'base' => NULL, 'refs' => [ 'TracePart$agentVersion' => '

The version of the agent.

', ], ], 'ApiContentMap' => [ 'base' => NULL, 'refs' => [ 'ApiRequestBody$content' => '

The content of the request body. The key of the object in this field is a media type defining the format of the request body.

', ], ], 'ApiInvocationInput' => [ 'base' => '

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputMember$apiInvocationInput' => '

Contains information about the API operation that the agent predicts should be called.

', ], ], 'ApiParameter' => [ 'base' => '

Information about a parameter to provide to the API request.

This data type is used in the following API operations:

', 'refs' => [ 'ApiParameters$member' => NULL, ], ], 'ApiParameters' => [ 'base' => NULL, 'refs' => [ 'ApiInvocationInput$parameters' => '

The parameters to provide for the API request, as the agent elicited from the user.

', ], ], 'ApiPath' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$apiPath' => '

The path to the API to call, based off the action group.

', 'ApiInvocationInput$apiPath' => '

The path to the API operation.

', 'ApiResult$apiPath' => '

The path to the API operation.

', ], ], 'ApiRequestBody' => [ 'base' => '

The request body to provide for the API request, as the agent elicited from the user.

This data type is used in the following API operations:

', 'refs' => [ 'ApiInvocationInput$requestBody' => '

The request body to provide for the API request, as the agent elicited from the user.

', ], ], 'ApiResult' => [ 'base' => '

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationResultMember$apiResult' => '

The result from the API response from the action group invocation.

', ], ], 'Attribution' => [ 'base' => '

Contains citations for a part of an agent response.

', 'refs' => [ 'PayloadPart$attribution' => '

Contains citations for a part of an agent response.

', ], ], 'BadGatewayException' => [ 'base' => '

There was an issue with a dependency due to a server issue. Retry your request.

', 'refs' => [ 'FlowResponseStream$badGatewayException' => '

There was an issue with a dependency due to a server issue. Retry your request.

', 'ResponseStream$badGatewayException' => '

There was an issue with a dependency due to a server issue. Retry your request.

', ], ], 'BedrockModelArn' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$modelArn' => '

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn' => '

The ARN of the foundation model used to generate a response.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CodeInterpreterInvocationOutput$executionTimeout' => '

Indicates if the execution of the code timed out.

', 'InvokeAgentRequest$enableTrace' => '

Specifies whether to turn on the trace or not to track the agent\'s reasoning process. For more information, see Trace enablement.

', 'InvokeAgentRequest$endSession' => '

Specifies whether to end the session with the agent or not.

', 'PreProcessingParsedResponse$isValid' => '

Whether the user input is valid or not. If false, the agent doesn\'t proceed to orchestration.

', ], ], 'ByteContentBlob' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$data' => '

The byte value of the file to upload, encoded as a Base-64 string.

', 'ByteContentFile$data' => '

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.

', ], ], 'ByteContentDoc' => [ 'base' => '

This property contains the document to chat with, along with its attributes.

', 'refs' => [ 'ExternalSource$byteContent' => '

The identifier, contentType, and data of the external source wrapper object.

', ], ], 'ByteContentFile' => [ 'base' => '

The property contains the file to chat with, along with its attributes.

', 'refs' => [ 'FileSource$byteContent' => '

The data and the text of the attached files.

', ], ], 'Citation' => [ 'base' => '

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

', 'refs' => [ 'Citations$member' => NULL, ], ], 'Citations' => [ 'base' => NULL, 'refs' => [ 'Attribution$citations' => '

A list of citations and related information for a part of an agent response.

', 'RetrieveAndGenerateResponse$citations' => '

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

', ], ], 'CodeInterpreterInvocationInput' => [ 'base' => '

Contains information about the code interpreter being invoked.

', 'refs' => [ 'InvocationInput$codeInterpreterInvocationInput' => '

Contains information about the code interpreter to be invoked.

', ], ], 'CodeInterpreterInvocationOutput' => [ 'base' => '

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

', 'refs' => [ 'Observation$codeInterpreterInvocationOutput' => '

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

', ], ], 'ConfirmationState' => [ 'base' => NULL, 'refs' => [ 'ApiResult$confirmationState' => '

Controls the API operations or functions to invoke based on the user confirmation.

', 'FunctionResult$confirmationState' => '

Contains the user confirmation information about the function that was called.

', ], ], 'ConflictException' => [ 'base' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', 'refs' => [ 'FlowResponseStream$conflictException' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', 'ResponseStream$conflictException' => '

There was a conflict performing an operation. Resolve the conflict and retry your request.

', ], ], 'ContentBody' => [ 'base' => '

Contains the body of the API response.

This data type is used in the following API operations:

', 'refs' => [ 'ResponseBody$value' => NULL, ], ], 'ContentMap' => [ 'base' => NULL, 'refs' => [ 'RequestBody$content' => '

The content in the request body.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$contentType' => '

The MIME type of the document contained in the wrapper object.

', ], ], 'CreationMode' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$parserMode' => '

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

', 'ModelInvocationInput$promptCreationMode' => '

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.

', ], ], 'DateTimestamp' => [ 'base' => '

Time Stamp.

', 'refs' => [ 'MemorySessionSummary$sessionExpiryTime' => '

The time when the memory duration for the session is set to end.

', 'MemorySessionSummary$sessionStartTime' => '

The start time for this session.

', ], ], 'DeleteAgentMemoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAgentMemoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailedException' => [ 'base' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', 'refs' => [ 'FlowResponseStream$dependencyFailedException' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', 'ResponseStream$dependencyFailedException' => '

There was an issue with a dependency. Check the resource configurations and retry the request.

', ], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'FlowInputContent$document' => '

The input to send to the prompt flow input node.

', 'FlowOutputContent$document' => '

The content in the output.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$score' => '

The level of relevance of the result to the query.

', ], ], 'ExecutionType' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$executionType' => '

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

', ], ], 'ExternalSource' => [ 'base' => '

The unique external source of the content contained in the wrapper object.

', 'refs' => [ 'ExternalSources$member' => NULL, ], ], 'ExternalSourceType' => [ 'base' => NULL, 'refs' => [ 'ExternalSource$sourceType' => '

The source type of the external source wrapper object.

', ], ], 'ExternalSources' => [ 'base' => NULL, 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$sources' => '

The document used with the external source wrapper object in the retrieveAndGenerate function.

', ], ], 'ExternalSourcesGenerationConfiguration' => [ 'base' => '

Contains the generation configuration of the external source wrapper object.

', 'refs' => [ 'ExternalSourcesRetrieveAndGenerateConfiguration$generationConfiguration' => '

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

', ], ], 'ExternalSourcesRetrieveAndGenerateConfiguration' => [ 'base' => '

The configurations of the external source wrapper object in the retrieveAndGenerate function.

', 'refs' => [ 'RetrieveAndGenerateConfiguration$externalSourcesConfiguration' => '

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

', ], ], 'FailureReasonString' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$failureReason' => '

The reason the interaction failed.

', ], ], 'FailureTrace' => [ 'base' => '

Contains information about the failure of the interaction.

', 'refs' => [ 'Trace$failureTrace' => '

Contains information about the failure of the interaction.

', ], ], 'FileBody' => [ 'base' => NULL, 'refs' => [ 'OutputFile$bytes' => '

The byte count of files that contains response from code interpreter.

', ], ], 'FilePart' => [ 'base' => '

Contains intermediate response for code interpreter if any files have been generated.

', 'refs' => [ 'ResponseStream$files' => '

Contains intermediate response for code interpreter if any files have been generated.

', ], ], 'FileSource' => [ 'base' => '

The source file of the content contained in the wrapper object.

', 'refs' => [ 'InputFile$source' => '

Specifies where the files are located.

', ], ], 'FileSourceType' => [ 'base' => NULL, 'refs' => [ 'FileSource$sourceType' => '

The source type of the files to attach.

', ], ], 'FileUseCase' => [ 'base' => NULL, 'refs' => [ 'InputFile$useCase' => '

Specifies how the source files will be used by the code interpreter.

', ], ], 'Files' => [ 'base' => NULL, 'refs' => [ 'CodeInterpreterInvocationInput$files' => '

Files that are uploaded for code interpreter to use.

', 'CodeInterpreterInvocationOutput$files' => '

Contains output files, if generated by code execution.

', ], ], 'FilterAttribute' => [ 'base' => '

Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievalFilter$equals' => '

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is cat:

"equals": { "key": "animal", "value": "cat" }

', 'RetrievalFilter$greaterThan' => '

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 }

', 'RetrievalFilter$greaterThanOrEquals' => '

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 }

', 'RetrievalFilter$in' => '

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"] }

', 'RetrievalFilter$lessThan' => '

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 }

', 'RetrievalFilter$lessThanOrEquals' => '

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 }

', 'RetrievalFilter$listContains' => '

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" }

', 'RetrievalFilter$notEquals' => '

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn\'t match the value in this object are returned.

The following example would return data sources that don\'t contain an animal attribute whose value is cat.

"notEquals": { "key": "animal", "value": "cat" }

', 'RetrievalFilter$notIn' => '

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"] }

', 'RetrievalFilter$startsWith' => '

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" }

', 'RetrievalFilter$stringContains' => '

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:

', ], ], 'FilterKey' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$key' => '

The name that the metadata attribute must match.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterAttribute$value' => '

The value to whcih to compare the value of the metadata attribute.

', ], ], 'FinalResponse' => [ 'base' => '

Contains details about the response to the user.

', 'refs' => [ 'Observation$finalResponse' => '

Contains details about the response to the user.

', ], ], 'FinalResponseString' => [ 'base' => NULL, 'refs' => [ 'FinalResponse$text' => '

The text in the response to the user.

', ], ], 'FlowAliasIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$flowAliasIdentifier' => '

The unique identifier of the flow alias.

', ], ], 'FlowCompletionEvent' => [ 'base' => '

Contains information about why a flow completed.

This data type is used in the following API operations:

', 'refs' => [ 'FlowResponseStream$flowCompletionEvent' => '

Contains information about why the flow completed.

', ], ], 'FlowCompletionReason' => [ 'base' => NULL, 'refs' => [ 'FlowCompletionEvent$completionReason' => '

The reason that the flow completed.

', ], ], 'FlowIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$flowIdentifier' => '

The unique identifier of the flow.

', ], ], 'FlowInput' => [ 'base' => '

Contains information about an input into the prompt flow and where to send it.

This data type is used in the following API operations:

', 'refs' => [ 'FlowInputs$member' => NULL, ], ], 'FlowInputContent' => [ 'base' => '

Contains information about an input into the flow.

This data type is used in the following API operations:

', 'refs' => [ 'FlowInput$content' => '

Contains information about an input into the prompt flow.

', ], ], 'FlowInputs' => [ 'base' => NULL, 'refs' => [ 'InvokeFlowRequest$inputs' => '

A list of objects, each containing information about an input into the flow.

', ], ], 'FlowOutputContent' => [ 'base' => '

Contains information about the content in an output from prompt flow invocation.

This data type is used in the following API operations:

', 'refs' => [ 'FlowOutputEvent$content' => '

The content in the output.

', ], ], 'FlowOutputEvent' => [ 'base' => '

Contains information about an output from prompt flow invoction.

This data type is used in the following API operations:

', 'refs' => [ 'FlowResponseStream$flowOutputEvent' => '

Contains information about an output from flow invocation.

', ], ], 'FlowResponseStream' => [ 'base' => '

The output of the flow.

This data type is used in the following API operations:

', 'refs' => [ 'InvokeFlowResponse$responseStream' => '

The output of the flow, returned as a stream. If there\'s an error, the error is returned.

', ], ], 'Function' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$function' => '

The function in the action group to call.

', ], ], 'FunctionInvocationInput' => [ 'base' => '

Contains information about the function that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputMember$functionInvocationInput' => '

Contains information about the function that the agent predicts should be called.

', ], ], 'FunctionParameter' => [ 'base' => '

Contains information about a parameter of the function.

This data type is used in the following API operations:

', 'refs' => [ 'FunctionParameters$member' => NULL, ], ], 'FunctionParameters' => [ 'base' => NULL, 'refs' => [ 'FunctionInvocationInput$parameters' => '

A list of parameters of the function.

', ], ], 'FunctionResult' => [ 'base' => '

Contains information about the function that was called from the action group and the response that was returned.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationResultMember$functionResult' => '

The result from the function from the action group invocation.

', ], ], 'GeneratedResponsePart' => [ 'base' => '

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

', 'refs' => [ 'Citation$generatedResponsePart' => '

Contains the generated response and metadata

', ], ], 'GenerationConfiguration' => [ 'base' => '

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration' => '

Contains configurations for response generation based on the knowledge base query results.

', ], ], 'GetAgentMemoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAgentMemoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GuadrailAction' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateResponse$guardrailAction' => '

Specifies if there is a guardrail intervention in the response.

', ], ], 'GuardrailAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$action' => '

The trace action details used with the Guardrail.

', ], ], 'GuardrailAssessment' => [ 'base' => '

Assessment details of the content analyzed by Guardrails.

', 'refs' => [ 'GuardrailAssessmentList$member' => NULL, ], ], 'GuardrailAssessmentList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTrace$inputAssessments' => '

The details of the input assessments used in the Guardrail Trace.

', 'GuardrailTrace$outputAssessments' => '

The details of the output assessments used in the Guardrail Trace.

', ], ], 'GuardrailConfiguration' => [ 'base' => '

The configuration details for the guardrail.

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$guardrailConfiguration' => '

The configuration details for the guardrail.

', 'GenerationConfiguration$guardrailConfiguration' => '

The configuration details for the guardrail.

', ], ], 'GuardrailConfigurationGuardrailIdString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailId' => '

The unique identifier for the guardrail.

', ], ], 'GuardrailConfigurationGuardrailVersionString' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$guardrailVersion' => '

The version of the guardrail.

', ], ], 'GuardrailContentFilter' => [ 'base' => '

Details of the content filter used in the Guardrail.

', 'refs' => [ 'GuardrailContentFilterList$member' => NULL, ], ], 'GuardrailContentFilterConfidence' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$confidence' => '

The confidence level regarding the content detected in the filter by the Guardrail.

', ], ], 'GuardrailContentFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentPolicyAssessment$filters' => '

The filter details of the policy assessment used in the Guardrails filter.

', ], ], 'GuardrailContentFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$type' => '

The type of content detected in the filter by the Guardrail.

', ], ], 'GuardrailContentPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$action' => '

The action placed on the content by the Guardrail filter.

', ], ], 'GuardrailContentPolicyAssessment' => [ 'base' => '

The details of the policy assessment in the Guardrails filter.

', 'refs' => [ 'GuardrailAssessment$contentPolicy' => '

Content policy details of the Guardrail.

', ], ], 'GuardrailCustomWord' => [ 'base' => '

The custom word details for the filter in the Guardrail.

', 'refs' => [ 'GuardrailCustomWordList$member' => NULL, ], ], 'GuardrailCustomWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$customWords' => '

The custom word details for words defined in the Guardrail filter.

', ], ], 'GuardrailManagedWord' => [ 'base' => '

The managed word details for the filter in the Guardrail.

', 'refs' => [ 'GuardrailManagedWordList$member' => NULL, ], ], 'GuardrailManagedWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$managedWordLists' => '

The managed word lists for words defined in the Guardrail filter.

', ], ], 'GuardrailManagedWordType' => [ 'base' => NULL, 'refs' => [ 'GuardrailManagedWord$type' => '

The type details for the managed word filter in the Guardrail.

', ], ], 'GuardrailPiiEntityFilter' => [ 'base' => '

The Guardrail filter to identify and remove personally identifiable information (PII).

', 'refs' => [ 'GuardrailPiiEntityFilterList$member' => NULL, ], ], 'GuardrailPiiEntityFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$piiEntities' => '

The details of the PII entities used in the sensitive policy assessment for the Guardrail.

', ], ], 'GuardrailPiiEntityType' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$type' => '

The type of PII the Guardrail filter has identified and removed.

', ], ], 'GuardrailRegexFilter' => [ 'base' => '

The details for the regex filter used in the Guardrail.

', 'refs' => [ 'GuardrailRegexFilterList$member' => NULL, ], ], 'GuardrailRegexFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$regexes' => '

The details of the regexes used in the sensitive policy assessment for the Guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$action' => '

The action of the Guardrail filter to identify and remove PII.

', 'GuardrailRegexFilter$action' => '

The action details for the regex filter used in the Guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'base' => '

The details of the sensitive policy assessment used in the Guardrail.

', 'refs' => [ 'GuardrailAssessment$sensitiveInformationPolicy' => '

Sensitive Information policy details of Guardrail.

', ], ], 'GuardrailTopic' => [ 'base' => '

The details for a specific topic defined in the Guardrail.

', 'refs' => [ 'GuardrailTopicList$member' => NULL, ], ], 'GuardrailTopicList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopicPolicyAssessment$topics' => '

The topic details of the policy assessment used in the Guardrail.

', ], ], 'GuardrailTopicPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$action' => '

The action details on a specific topic in the Guardrail.

', ], ], 'GuardrailTopicPolicyAssessment' => [ 'base' => '

The details of the policy assessment used in the Guardrail.

', 'refs' => [ 'GuardrailAssessment$topicPolicy' => '

Topic policy details of the Guardrail.

', ], ], 'GuardrailTopicType' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$type' => '

The type details on a specific topic in the Guardrail.

', ], ], 'GuardrailTrace' => [ 'base' => '

The trace details used in the Guardrail.

', 'refs' => [ 'Trace$guardrailTrace' => '

The trace details for a trace defined in the Guardrail filter.

', ], ], 'GuardrailWordPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailCustomWord$action' => '

The action details for the custom word filter in the Guardrail.

', 'GuardrailManagedWord$action' => '

The action details for the managed word filter in the Guardrail.

', ], ], 'GuardrailWordPolicyAssessment' => [ 'base' => '

The assessment details for words defined in the Guardrail filter.

', 'refs' => [ 'GuardrailAssessment$wordPolicy' => '

Word policy details of the Guardrail.

', ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'ByteContentDoc$identifier' => '

The file name of the document contained in the wrapper object.

', ], ], 'InferenceConfig' => [ 'base' => '

The configuration for inference settings when generating responses using RetrieveAndGenerate.

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$inferenceConfig' => '

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

', 'GenerationConfiguration$inferenceConfig' => '

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

', ], ], 'InferenceConfiguration' => [ 'base' => '

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

', 'refs' => [ 'ModelInvocationInput$inferenceConfiguration' => '

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

', ], ], 'InputFile' => [ 'base' => '

Contains details of the source files.

', 'refs' => [ 'InputFiles$member' => NULL, ], ], 'InputFiles' => [ 'base' => NULL, 'refs' => [ 'SessionState$files' => '

Contains information about the files used by code interpreter.

', ], ], 'InputText' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$inputText' => '

The prompt text to send the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ApiResult$httpStatusCode' => '

http status code from API execution response (for example: 200, 400, 500).

', 'Usage$inputTokens' => '

Contains information about the input tokens from the foundation model usage.

', 'Usage$outputTokens' => '

Contains information about the output tokens from the foundation model usage.

', ], ], 'InternalServerException' => [ 'base' => '

An internal server error occurred. Retry your request.

', 'refs' => [ 'FlowResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', 'ResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', ], ], 'InvocationInput' => [ 'base' => '

Contains information pertaining to the action group or knowledge base that is being invoked.

', 'refs' => [ 'OrchestrationTrace$invocationInput' => '

Contains information pertaining to the action group or knowledge base that is being invoked.

', ], ], 'InvocationInputMember' => [ 'base' => '

Contains details about the API operation or function that the agent predicts should be called.

This data type is used in the following API operations:

', 'refs' => [ 'InvocationInputs$member' => NULL, ], ], 'InvocationInputs' => [ 'base' => NULL, 'refs' => [ 'ReturnControlPayload$invocationInputs' => '

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

', ], ], 'InvocationResultMember' => [ 'base' => '

A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.

This data type is used in the following API operations:

', 'refs' => [ 'ReturnControlInvocationResults$member' => NULL, ], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationInput$invocationType' => '

Specifies whether the agent is invoking an action group or a knowledge base.

', ], ], 'InvokeAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InvokeFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateSessionConfiguration$kmsKeyArn' => '

The ARN of the KMS key encrypting the session.

', ], ], 'KnowledgeBaseConfiguration' => [ 'base' => '

Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.

', 'refs' => [ 'KnowledgeBaseConfigurations$member' => NULL, ], ], 'KnowledgeBaseConfigurations' => [ 'base' => NULL, 'refs' => [ 'SessionState$knowledgeBaseConfigurations' => '

An array of configurations, each of which applies to a knowledge base attached to the agent.

', ], ], 'KnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseConfiguration$knowledgeBaseId' => '

The unique identifier for a knowledge base attached to the agent.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$knowledgeBaseId' => '

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

', 'RetrieveRequest$knowledgeBaseId' => '

The unique identifier of the knowledge base to query.

', ], ], 'KnowledgeBaseLookupInput' => [ 'base' => '

Contains details about the knowledge base to look up and the query to be made.

', 'refs' => [ 'InvocationInput$knowledgeBaseLookupInput' => '

Contains details about the knowledge base to look up and the query to be made.

', ], ], 'KnowledgeBaseLookupInputString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$text' => '

The query made to the knowledge base.

', ], ], 'KnowledgeBaseLookupOutput' => [ 'base' => '

Contains details about the results from looking up the knowledge base.

', 'refs' => [ 'Observation$knowledgeBaseLookupOutput' => '

Contains details about the results from looking up the knowledge base.

', ], ], 'KnowledgeBaseQuery' => [ 'base' => '

Contains the query made to the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveRequest$retrievalQuery' => '

Contains the query to send the knowledge base.

', ], ], 'KnowledgeBaseQueryTextString' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseQuery$text' => '

The text of the query made to the knowledge base.

', ], ], 'KnowledgeBaseRetrievalConfiguration' => [ 'base' => '

Contains configurations for knowledge base query. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseConfiguration$retrievalConfiguration' => '

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

', 'KnowledgeBaseRetrieveAndGenerateConfiguration$retrievalConfiguration' => '

Contains configurations for how to retrieve and return the knowledge base query.

', 'RetrieveRequest$retrievalConfiguration' => '

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

', ], ], 'KnowledgeBaseRetrievalResult' => [ 'base' => '

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResults$member' => NULL, ], ], 'KnowledgeBaseRetrievalResults' => [ 'base' => NULL, 'refs' => [ 'RetrieveResponse$retrievalResults' => '

A list of results from querying the knowledge base.

', ], ], 'KnowledgeBaseRetrieveAndGenerateConfiguration' => [ 'base' => '

Contains details about the resource being queried.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateConfiguration$knowledgeBaseConfiguration' => '

Contains details about the resource being queried.

', ], ], 'KnowledgeBaseVectorSearchConfiguration' => [ 'base' => '

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalConfiguration$vectorSearchConfiguration' => '

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

', ], ], 'KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$numberOfResults' => '

The number of source chunks to retrieve.

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$overrideLambda' => '

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

', ], ], 'MaxResults' => [ 'base' => '

Max Results.

', 'refs' => [ 'GetAgentMemoryRequest$maxItems' => '

The maximum number of items 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.

', ], ], 'MaxTokens' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$maxTokens' => '

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maximumLength' => '

The maximum number of tokens allowed in the generated response.

', ], ], 'Memories' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryResponse$memoryContents' => '

Contains details of the sessions stored in the memory

', ], ], 'Memory' => [ 'base' => '

Contains sessions summaries.

', 'refs' => [ 'Memories$member' => NULL, ], ], 'MemoryId' => [ 'base' => NULL, 'refs' => [ 'DeleteAgentMemoryRequest$memoryId' => '

The unique identifier of the memory.

', 'GetAgentMemoryRequest$memoryId' => '

The unique identifier of the memory.

', 'InvokeAgentRequest$memoryId' => '

The unique identifier of the agent memory.

', 'InvokeAgentResponse$memoryId' => '

The unique identifier of the agent memory.

', 'MemorySessionSummary$memoryId' => '

The unique identifier of the memory where the session summary is stored.

', ], ], 'MemorySessionSummary' => [ 'base' => '

Contains details of a session summary.

', 'refs' => [ 'Memory$sessionSummary' => '

Contains summary of a session.

', ], ], 'MemoryType' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryRequest$memoryType' => '

The type of memory.

', ], ], 'Metadata' => [ 'base' => '

Provides details of the foundation model.

', 'refs' => [ 'OrchestrationModelInvocationOutput$metadata' => '

Contains information about the foundation model output.

', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'ByteContentFile$mediaType' => '

The MIME type of data contained in the file used for chat.

', 'InvokeAgentResponse$contentType' => '

The MIME type of the input data in the request. The default value is application/json.

', 'OutputFile$type' => '

The type of file that contains response from the code interpreter.

', ], ], 'ModelInvocationInput' => [ 'base' => '

The input for the pre-processing step.

', 'refs' => [ 'OrchestrationTrace$modelInvocationInput' => '

The input for the orchestration step.

', 'PostProcessingTrace$modelInvocationInput' => '

The input for the post-processing step.

', 'PreProcessingTrace$modelInvocationInput' => '

The input for the pre-processing step.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetAgentMemoryRequest$nextToken' => '

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.

', 'GetAgentMemoryResponse$nextToken' => '

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.

', 'RetrieveRequest$nextToken' => '

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.

', 'RetrieveResponse$nextToken' => '

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.

', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'FlowInput$nodeName' => '

The name of the flow input node that begins the prompt flow.

', 'FlowOutputEvent$nodeName' => '

The name of the flow output node that the output is from.

', ], ], 'NodeOutputName' => [ 'base' => NULL, 'refs' => [ 'FlowInput$nodeOutputName' => '

The name of the output from the flow input node that begins the prompt flow.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'FlowOutputEvent$nodeType' => '

The type of the node that the output is from.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'BadGatewayException$message' => NULL, 'BadGatewayException$resourceName' => '

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

', 'ConflictException$message' => NULL, 'DependencyFailedException$message' => NULL, 'DependencyFailedException$resourceName' => '

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

', 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'Observation' => [ 'base' => '

Contains the result or output of an action group or knowledge base, or the response to the user.

', 'refs' => [ 'OrchestrationTrace$observation' => '

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

', ], ], 'OrchestrationConfiguration' => [ 'base' => '

Settings for how the model processes the prompt prior to retrieval and generation.

', 'refs' => [ 'KnowledgeBaseRetrieveAndGenerateConfiguration$orchestrationConfiguration' => '

Settings for how the model processes the prompt prior to retrieval and generation.

', ], ], 'OrchestrationModelInvocationOutput' => [ 'base' => '

The foundation model output from the orchestration step.

', 'refs' => [ 'OrchestrationTrace$modelInvocationOutput' => '

Contains information pertaining to the output from the foundation model that is being invoked.

', ], ], 'OrchestrationTrace' => [ 'base' => '

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

', 'refs' => [ 'Trace$orchestrationTrace' => '

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

', ], ], 'OutputFile' => [ 'base' => '

Contains details of the response from code interpreter.

', 'refs' => [ 'OutputFiles$member' => NULL, ], ], 'OutputFiles' => [ 'base' => NULL, 'refs' => [ 'FilePart$files' => '

Files containing intermediate response for the user.

', ], ], 'OutputString' => [ 'base' => NULL, 'refs' => [ 'PostProcessingParsedResponse$text' => '

The text returned by the parser.

', ], ], 'Parameter' => [ 'base' => '

A parameter for the API request or function.

', 'refs' => [ 'ParameterList$member' => NULL, 'Parameters$member' => NULL, ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'PropertyParameters$properties' => '

A list of parameters in the request body.

', ], ], 'Parameters' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$parameters' => '

The parameters in the Lambda input event.

', 'ContentMap$value' => NULL, ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => '

A part of the agent response in bytes.

', ], ], 'PayloadPart' => [ 'base' => '

Contains a part of an agent response and citations for it.

', 'refs' => [ 'ResponseStream$chunk' => '

Contains a part of an agent response and citations for it.

', ], ], 'PostProcessingModelInvocationOutput' => [ 'base' => '

The foundation model output from the post-processing step.

', 'refs' => [ 'PostProcessingTrace$modelInvocationOutput' => '

The foundation model output from the post-processing step.

', ], ], 'PostProcessingParsedResponse' => [ 'base' => '

Details about the response from the Lambda parsing of the output from the post-processing step.

', 'refs' => [ 'PostProcessingModelInvocationOutput$parsedResponse' => '

Details about the response from the Lambda parsing of the output of the post-processing step.

', ], ], 'PostProcessingTrace' => [ 'base' => '

Details about the post-processing step, in which the agent shapes the response.

', 'refs' => [ 'Trace$postProcessingTrace' => '

Details about the post-processing step, in which the agent shapes the response..

', ], ], 'PreProcessingModelInvocationOutput' => [ 'base' => '

The foundation model output from the pre-processing step.

', 'refs' => [ 'PreProcessingTrace$modelInvocationOutput' => '

The foundation model output from the pre-processing step.

', ], ], 'PreProcessingParsedResponse' => [ 'base' => '

Details about the response from the Lambda parsing of the output from the pre-processing step.

', 'refs' => [ 'PreProcessingModelInvocationOutput$parsedResponse' => '

Details about the response from the Lambda parsing of the output of the pre-processing step.

', ], ], 'PreProcessingTrace' => [ 'base' => '

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

', 'refs' => [ 'Trace$preProcessingTrace' => '

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

', ], ], 'PromptSessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$promptSessionAttributes' => '

Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.

', ], ], 'PromptTemplate' => [ 'base' => '

Contains the template for the prompt that\'s sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

', 'refs' => [ 'ExternalSourcesGenerationConfiguration$promptTemplate' => '

Contain the textPromptTemplate string for the external source wrapper object.

', 'GenerationConfiguration$promptTemplate' => '

Contains the template for the prompt that\'s sent to the model for response generation.

', ], ], 'PromptText' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$text' => '

The text that prompted the agent at this step.

', ], ], 'PromptType' => [ 'base' => NULL, 'refs' => [ 'ModelInvocationInput$type' => '

The step in the agent sequence.

', ], ], 'PropertyParameters' => [ 'base' => '

Contains the parameters in the request body.

', 'refs' => [ 'ApiContentMap$value' => NULL, ], ], 'QueryTransformationConfiguration' => [ 'base' => '

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

', 'refs' => [ 'OrchestrationConfiguration$queryTransformationConfiguration' => '

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

', ], ], 'QueryTransformationType' => [ 'base' => NULL, 'refs' => [ 'QueryTransformationConfiguration$type' => '

The type of transformation to apply to the prompt.

', ], ], 'RAGStopSequences' => [ 'base' => NULL, 'refs' => [ 'TextInferenceConfig$stopSequences' => '

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

', ], ], 'RAGStopSequencesMemberString' => [ 'base' => NULL, 'refs' => [ 'RAGStopSequences$member' => NULL, ], ], 'Rationale' => [ 'base' => '

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

', 'refs' => [ 'OrchestrationTrace$rationale' => '

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

', ], ], 'RationaleString' => [ 'base' => NULL, 'refs' => [ 'PreProcessingParsedResponse$rationale' => '

The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.

', 'Rationale$text' => '

The reasoning or thought process of the agent, based on the input.

', ], ], 'RawResponse' => [ 'base' => '

Contains the raw output from the foundation model.

', 'refs' => [ 'OrchestrationModelInvocationOutput$rawResponse' => '

Contains details of the raw response from the foundation model output.

', ], ], 'RepromptResponse' => [ 'base' => '

Contains details about the agent\'s response to reprompt the input.

', 'refs' => [ 'Observation$repromptResponse' => '

Contains details about the response to reprompt the input.

', ], ], 'RequestBody' => [ 'base' => '

The parameters in the API request body.

', 'refs' => [ 'ActionGroupInvocationInput$requestBody' => '

The parameters in the request body for the Lambda input event.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', 'refs' => [ 'FlowResponseStream$resourceNotFoundException' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', 'ResponseStream$resourceNotFoundException' => '

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

', ], ], 'ResponseBody' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseBody' => '

The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

', 'FunctionResult$responseBody' => '

The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

', ], ], 'ResponseState' => [ 'base' => NULL, 'refs' => [ 'ApiResult$responseState' => '

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

', 'FunctionResult$responseState' => '

Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt

', ], ], 'ResponseStream' => [ 'base' => '

The response from invoking the agent and associated citations and trace information.

', 'refs' => [ 'InvokeAgentResponse$completion' => '

The agent\'s response to the user prompt.

', ], ], 'RetrievalFilter' => [ 'base' => '

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$filter' => '

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

', 'RetrievalFilterList$member' => NULL, ], ], 'RetrievalFilterList' => [ 'base' => NULL, 'refs' => [ 'RetrievalFilter$andAll' => '

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

', 'RetrievalFilter$orAll' => '

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

', ], ], 'RetrievalResultConfluenceLocation' => [ 'base' => '

The Confluence data source location.

', 'refs' => [ 'RetrievalResultLocation$confluenceLocation' => '

The Confluence data source location.

', ], ], 'RetrievalResultContent' => [ 'base' => '

Contains the cited text from the data source.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResult$content' => '

Contains a chunk of text from a data source in the knowledge base.

', 'RetrievedReference$content' => '

Contains the cited text from the data source.

', ], ], 'RetrievalResultLocation' => [ 'base' => '

Contains information about the data source location.

This data type is used in the following API operations:

', 'refs' => [ 'KnowledgeBaseRetrievalResult$location' => '

Contains information about the location of the data source.

', 'RetrievedReference$location' => '

Contains information about the location of the data source.

', ], ], 'RetrievalResultLocationType' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultLocation$type' => '

The type of data source location.

', ], ], 'RetrievalResultMetadata' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseRetrievalResult$metadata' => '

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

', 'RetrievedReference$metadata' => '

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

', ], ], 'RetrievalResultMetadataKey' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$key' => NULL, ], ], 'RetrievalResultMetadataValue' => [ 'base' => NULL, 'refs' => [ 'RetrievalResultMetadata$value' => NULL, ], ], 'RetrievalResultS3Location' => [ 'base' => '

The S3 data source location.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievalResultLocation$s3Location' => '

The S3 data source location.

', ], ], 'RetrievalResultSalesforceLocation' => [ 'base' => '

The Salesforce data source location.

', 'refs' => [ 'RetrievalResultLocation$salesforceLocation' => '

The Salesforce data source location.

', ], ], 'RetrievalResultSharePointLocation' => [ 'base' => '

The SharePoint data source location.

', 'refs' => [ 'RetrievalResultLocation$sharePointLocation' => '

The SharePoint data source location.

', ], ], 'RetrievalResultWebLocation' => [ 'base' => '

The web URL/URLs data source location.

', 'refs' => [ 'RetrievalResultLocation$webLocation' => '

The web URL/URLs data source location.

', ], ], 'RetrieveAndGenerateConfiguration' => [ 'base' => '

Contains details about the resource being queried.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$retrieveAndGenerateConfiguration' => '

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

', ], ], 'RetrieveAndGenerateInput' => [ 'base' => '

Contains the query made to the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$input' => '

Contains the query to be made to the knowledge base.

', ], ], 'RetrieveAndGenerateInputTextString' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateInput$text' => '

The query made to the knowledge base.

', ], ], 'RetrieveAndGenerateOutput' => [ 'base' => '

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateResponse$output' => '

Contains the response generated from querying the knowledge base.

', ], ], 'RetrieveAndGenerateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveAndGenerateSessionConfiguration' => [ 'base' => '

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

', 'refs' => [ 'RetrieveAndGenerateRequest$sessionConfiguration' => '

Contains details about the session with the knowledge base.

', ], ], 'RetrieveAndGenerateType' => [ 'base' => NULL, 'refs' => [ 'RetrieveAndGenerateConfiguration$type' => '

The type of resource that is queried by the request.

', ], ], 'RetrieveRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetrieveResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetrievedReference' => [ 'base' => '

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

', 'refs' => [ 'RetrievedReferences$member' => NULL, ], ], 'RetrievedReferences' => [ 'base' => NULL, 'refs' => [ 'Citation$retrievedReferences' => '

Contains metadata about the sources cited for the generated response.

', 'KnowledgeBaseLookupOutput$retrievedReferences' => '

Contains metadata about the sources cited for the generated response.

', ], ], 'ReturnControlInvocationResults' => [ 'base' => NULL, 'refs' => [ 'SessionState$returnControlInvocationResults' => '

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

', ], ], 'ReturnControlPayload' => [ 'base' => '

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the following API operations:

', 'refs' => [ 'ResponseStream$returnControl' => '

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

', ], ], 'S3ObjectDoc' => [ 'base' => '

The unique wrapper object of the document from the S3 location.

', 'refs' => [ 'ExternalSource$s3Location' => '

The S3 location of the external source wrapper object.

', ], ], 'S3ObjectFile' => [ 'base' => '

Contains details of the s3 object where the source file is located.

', 'refs' => [ 'FileSource$s3Location' => '

The s3 location of the files to attach.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'S3ObjectDoc$uri' => '

The file location of the S3 wrapper object.

', 'S3ObjectFile$uri' => '

The uri of the s3 object.

', ], ], 'SearchType' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseVectorSearchConfiguration$overrideSearchType' => '

By default, Amazon Bedrock decides a search strategy for you. If you\'re using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

The number of requests exceeds the service quota. Resubmit your request later.

', 'refs' => [ 'FlowResponseStream$serviceQuotaExceededException' => '

The number of requests exceeds the service quota. Resubmit your request later.

', 'ResponseStream$serviceQuotaExceededException' => '

The number of requests exceeds the service quota. Resubmit your request later.

', ], ], 'SessionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'SessionState$sessionAttributes' => '

Contains attributes that persist across a session and the values of those attributes.

', ], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'InvokeAgentRequest$sessionId' => '

The unique identifier of the session. Use the same value across requests to continue the same conversation.

', 'InvokeAgentResponse$sessionId' => '

The unique identifier of the session with the agent.

', 'MemorySessionSummary$sessionId' => '

The identifier for this session.

', 'RetrieveAndGenerateRequest$sessionId' => '

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.

', 'RetrieveAndGenerateResponse$sessionId' => '

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.

', 'TracePart$sessionId' => '

The unique identifier of the session with the agent.

', ], ], 'SessionState' => [ 'base' => '

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent\'s behavior. For more information, see Control session context.

', 'refs' => [ 'InvokeAgentRequest$sessionState' => '

Contains parameters that specify various attributes of the session. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

', ], ], 'Source' => [ 'base' => NULL, 'refs' => [ 'RepromptResponse$source' => '

Specifies what output is prompting the agent to reprompt the input.

', ], ], 'Span' => [ 'base' => '

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

', 'refs' => [ 'TextResponsePart$span' => '

Contains information about where the text with a citation begins and ends in the generated output.

', ], ], 'SpanEndInteger' => [ 'base' => NULL, 'refs' => [ 'Span$end' => '

Where the text with a citation ends in the generated output.

', ], ], 'SpanStartInteger' => [ 'base' => NULL, 'refs' => [ 'Span$start' => '

Where the text with a citation starts in the generated output.

', ], ], 'StopSequences' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => '

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$invocationId' => '

The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

', 'ApiContentMap$key' => NULL, 'ApiInvocationInput$actionGroup' => '

The action group that the API operation belongs to.

', 'ApiInvocationInput$httpMethod' => '

The HTTP method of the API operation.

', 'ApiParameter$name' => '

The name of the parameter.

', 'ApiParameter$type' => '

The data type for the parameter.

', 'ApiParameter$value' => '

The value of the parameter.

', 'ApiResult$actionGroup' => '

The action group that the API operation belongs to.

', 'ApiResult$httpMethod' => '

The HTTP method for the API operation.

', 'CodeInterpreterInvocationInput$code' => '

The code for the code interpreter to use.

', 'CodeInterpreterInvocationOutput$executionError' => '

Contains the error returned from code execution.

', 'CodeInterpreterInvocationOutput$executionOutput' => '

Contains the successful output returned from code execution

', 'ContentBody$body' => '

The body of the API response.

', 'ContentMap$key' => NULL, 'Files$member' => NULL, 'FunctionInvocationInput$actionGroup' => '

The action group that the function belongs to.

', 'FunctionInvocationInput$function' => '

The name of the function.

', 'FunctionParameter$name' => '

The name of the parameter.

', 'FunctionParameter$type' => '

The data type of the parameter.

', 'FunctionParameter$value' => '

The value of the parameter.

', 'FunctionResult$actionGroup' => '

The action group that the function belongs to.

', 'FunctionResult$function' => '

The name of the function that was called.

', 'GuardrailCustomWord$match' => '

The match details for the custom word filter in the Guardrail.

', 'GuardrailManagedWord$match' => '

The match details for the managed word filter in the Guardrail.

', 'GuardrailPiiEntityFilter$match' => '

The match to settings in the Guardrail filter to identify and remove PII.

', 'GuardrailRegexFilter$match' => '

The match details for the regex filter used in the Guardrail.

', 'GuardrailRegexFilter$name' => '

The name details for the regex filter used in the Guardrail.

', 'GuardrailRegexFilter$regex' => '

The regex details for the regex filter used in the Guardrail.

', 'GuardrailTopic$name' => '

The name details on a specific topic in the Guardrail.

', 'InputFile$name' => '

The name of the source file.

', 'OutputFile$name' => '

The name of the file containing response from code interpreter.

', 'Parameter$name' => '

The name of the parameter.

', 'Parameter$type' => '

The type of the parameter.

', 'Parameter$value' => '

The value of the parameter.

', 'PromptSessionAttributesMap$key' => NULL, 'PromptSessionAttributesMap$value' => NULL, 'RawResponse$content' => '

The foundation model\'s raw output content.

', 'RepromptResponse$text' => '

The text reprompting the input.

', 'ResponseBody$key' => NULL, 'RetrievalResultConfluenceLocation$url' => '

The Confluence host URL for the data source location.

', 'RetrievalResultContent$text' => '

The cited text from the data source.

', 'RetrievalResultS3Location$uri' => '

The S3 URI for the data source location.

', 'RetrievalResultSalesforceLocation$url' => '

The Salesforce host URL for the data source location.

', 'RetrievalResultSharePointLocation$url' => '

The SharePoint site URL for the data source location.

', 'RetrievalResultWebLocation$url' => '

The web URL/URLs for the data source location.

', 'RetrieveAndGenerateOutput$text' => '

The response generated from querying the knowledge base.

', 'ReturnControlPayload$invocationId' => '

The identifier of the action group invocation.

', 'SessionAttributesMap$key' => NULL, 'SessionAttributesMap$value' => NULL, 'SessionState$invocationId' => '

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

', 'StopSequences$member' => NULL, 'TextResponsePart$text' => '

The part of the generated text that contains a citation.

', ], ], 'SummaryText' => [ 'base' => NULL, 'refs' => [ 'MemorySessionSummary$summaryText' => '

The summarized text for this session.

', ], ], 'Temperature' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => '

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

', 'TextInferenceConfig$temperature' => '

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

', ], ], 'TextInferenceConfig' => [ 'base' => '

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model\'s inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.

', 'refs' => [ 'InferenceConfig$textInferenceConfig' => '

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

', ], ], 'TextPromptTemplate' => [ 'base' => NULL, 'refs' => [ 'PromptTemplate$textPromptTemplate' => '

The template for the prompt that\'s sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

', ], ], 'TextResponsePart' => [ 'base' => '

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

', 'refs' => [ 'GeneratedResponsePart$textResponsePart' => '

Contains metadata about a textual part of the generated response that is accompanied by a citation.

', ], ], 'ThrottlingException' => [ 'base' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'refs' => [ 'FlowResponseStream$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'ResponseStream$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', ], ], 'TopK' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topK' => '

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

', ], ], 'TopP' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topP' => '

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.

', 'TextInferenceConfig$topP' => '

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

', ], ], 'Trace' => [ 'base' => '

Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', 'refs' => [ 'TracePart$trace' => '

Contains one part of the agent\'s reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', ], ], 'TraceId' => [ 'base' => NULL, 'refs' => [ 'FailureTrace$traceId' => '

The unique identifier of the trace.

', 'GuardrailTrace$traceId' => '

The details of the trace Id used in the Guardrail Trace.

', 'InvocationInput$traceId' => '

The unique identifier of the trace.

', 'ModelInvocationInput$traceId' => '

The unique identifier of the trace.

', 'Observation$traceId' => '

The unique identifier of the trace.

', 'OrchestrationModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'PostProcessingModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'PreProcessingModelInvocationOutput$traceId' => '

The unique identifier of the trace.

', 'Rationale$traceId' => '

The unique identifier of the trace step.

', ], ], 'TraceKnowledgeBaseId' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseLookupInput$knowledgeBaseId' => '

The unique identifier of the knowledge base to look up.

', ], ], 'TracePart' => [ 'base' => '

Contains information about the agent and session, alongside the agent\'s reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

', 'refs' => [ 'ResponseStream$trace' => '

Contains information about the agent and session, alongside the agent\'s reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Observation$type' => '

Specifies what kind of information the agent returns in the observation. The following values are possible.

', ], ], 'Usage' => [ 'base' => '

Contains information of the usage of the foundation model.

', 'refs' => [ 'Metadata$usage' => '

Contains details of the foundation model usage.

', ], ], 'ValidationException' => [ 'base' => '

Input validation failed. Check your request parameters and retry the request.

', 'refs' => [ 'FlowResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', 'ResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', ], ], 'Verb' => [ 'base' => NULL, 'refs' => [ 'ActionGroupInvocationInput$verb' => '

The API method being used, based off the action group.

', ], ], ],]; diff --git a/src/data/bedrock-runtime/2023-09-30/api-2.json b/src/data/bedrock-runtime/2023-09-30/api-2.json index 991bcda177..18e03fa4a6 100644 --- a/src/data/bedrock-runtime/2023-09-30/api-2.json +++ b/src/data/bedrock-runtime/2023-09-30/api-2.json @@ -1011,7 +1011,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})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([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]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)" }, "InvokeModelRequest":{ "type":"structure", @@ -1186,7 +1186,8 @@ "httpStatusCode":429, "senderFault":true }, - "exception":true + "exception":true, + "retryable":{"throttling":false} }, "ModelOutputs":{ "type":"list", diff --git a/src/data/bedrock-runtime/2023-09-30/api-2.json.php b/src/data/bedrock-runtime/2023-09-30/api-2.json.php index 747de5f1d9..9bebcff614 100644 --- a/src/data/bedrock-runtime/2023-09-30/api-2.json.php +++ b/src/data/bedrock-runtime/2023-09-30/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2023-09-30', 'auth' => [ 'aws.auth#sigv4', ], 'endpointPrefix' => 'bedrock-runtime', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon Bedrock Runtime', 'serviceId' => 'Bedrock Runtime', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-runtime-2023-09-30', ], 'operations' => [ 'ApplyGuardrail' => [ 'name' => 'ApplyGuardrail', 'http' => [ 'method' => 'POST', 'requestUri' => '/guardrail/{guardrailIdentifier}/version/{guardrailVersion}/apply', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ApplyGuardrailRequest', ], 'output' => [ 'shape' => 'ApplyGuardrailResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'Converse' => [ 'name' => 'Converse', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/converse', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ConverseRequest', ], 'output' => [ 'shape' => 'ConverseResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'ConverseStream' => [ 'name' => 'ConverseStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/converse-stream', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ConverseStreamRequest', ], 'output' => [ 'shape' => 'ConverseStreamResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'InvokeModel' => [ 'name' => 'InvokeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/invoke', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeModelRequest', ], 'output' => [ 'shape' => 'InvokeModelResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'InvokeModelWithResponseStream' => [ 'name' => 'InvokeModelWithResponseStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/invoke-with-response-stream', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeModelWithResponseStreamRequest', ], 'output' => [ 'shape' => 'InvokeModelWithResponseStreamResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ModelStreamErrorException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ModelErrorException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AnyToolChoice' => [ 'type' => 'structure', 'members' => [], ], 'ApplyGuardrailRequest' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', 'source', 'content', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'uri', 'locationName' => 'guardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'uri', 'locationName' => 'guardrailVersion', ], 'source' => [ 'shape' => 'GuardrailContentSource', ], 'content' => [ 'shape' => 'GuardrailContentBlockList', ], ], ], 'ApplyGuardrailResponse' => [ 'type' => 'structure', 'required' => [ 'usage', 'action', 'outputs', 'assessments', ], 'members' => [ 'usage' => [ 'shape' => 'GuardrailUsage', ], 'action' => [ 'shape' => 'GuardrailAction', ], 'outputs' => [ 'shape' => 'GuardrailOutputContentList', ], 'assessments' => [ 'shape' => 'GuardrailAssessmentList', ], ], ], 'AutoToolChoice' => [ 'type' => 'structure', 'members' => [], ], 'Body' => [ 'type' => 'blob', 'max' => 25000000, 'min' => 0, 'sensitive' => true, ], 'ContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'ImageBlock', ], 'document' => [ 'shape' => 'DocumentBlock', ], 'toolUse' => [ 'shape' => 'ToolUseBlock', ], 'toolResult' => [ 'shape' => 'ToolResultBlock', ], 'guardContent' => [ 'shape' => 'GuardrailConverseContentBlock', ], ], 'union' => true, ], 'ContentBlockDelta' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'toolUse' => [ 'shape' => 'ToolUseBlockDelta', ], ], 'union' => true, ], 'ContentBlockDeltaEvent' => [ 'type' => 'structure', 'required' => [ 'delta', 'contentBlockIndex', ], 'members' => [ 'delta' => [ 'shape' => 'ContentBlockDelta', ], 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlockStart' => [ 'type' => 'structure', 'members' => [ 'toolUse' => [ 'shape' => 'ToolUseBlockStart', ], ], 'union' => true, ], 'ContentBlockStartEvent' => [ 'type' => 'structure', 'required' => [ 'start', 'contentBlockIndex', ], 'members' => [ 'start' => [ 'shape' => 'ContentBlockStart', ], 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlockStopEvent' => [ 'type' => 'structure', 'required' => [ 'contentBlockIndex', ], 'members' => [ 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentBlock', ], ], 'ConversationRole' => [ 'type' => 'string', 'enum' => [ 'user', 'assistant', ], ], 'ConversationalModelId' => [ '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})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)', ], 'ConverseMetrics' => [ 'type' => 'structure', 'required' => [ 'latencyMs', ], 'members' => [ 'latencyMs' => [ 'shape' => 'Long', ], ], ], 'ConverseOutput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'union' => true, ], 'ConverseRequest' => [ 'type' => 'structure', 'required' => [ 'modelId', 'messages', ], 'members' => [ 'modelId' => [ 'shape' => 'ConversationalModelId', 'location' => 'uri', 'locationName' => 'modelId', ], 'messages' => [ 'shape' => 'Messages', ], 'system' => [ 'shape' => 'SystemContentBlocks', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfiguration', ], 'toolConfig' => [ 'shape' => 'ToolConfiguration', ], 'guardrailConfig' => [ 'shape' => 'GuardrailConfiguration', ], 'additionalModelRequestFields' => [ 'shape' => 'Document', ], 'additionalModelResponseFieldPaths' => [ 'shape' => 'ConverseRequestAdditionalModelResponseFieldPathsList', ], ], ], 'ConverseRequestAdditionalModelResponseFieldPathsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString', ], 'max' => 10, 'min' => 0, ], 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ConverseResponse' => [ 'type' => 'structure', 'required' => [ 'output', 'stopReason', 'usage', 'metrics', ], 'members' => [ 'output' => [ 'shape' => 'ConverseOutput', ], 'stopReason' => [ 'shape' => 'StopReason', ], 'usage' => [ 'shape' => 'TokenUsage', ], 'metrics' => [ 'shape' => 'ConverseMetrics', ], 'additionalModelResponseFields' => [ 'shape' => 'Document', ], 'trace' => [ 'shape' => 'ConverseTrace', ], ], ], 'ConverseStreamMetadataEvent' => [ 'type' => 'structure', 'required' => [ 'usage', 'metrics', ], 'members' => [ 'usage' => [ 'shape' => 'TokenUsage', ], 'metrics' => [ 'shape' => 'ConverseStreamMetrics', ], 'trace' => [ 'shape' => 'ConverseStreamTrace', ], ], 'event' => true, ], 'ConverseStreamMetrics' => [ 'type' => 'structure', 'required' => [ 'latencyMs', ], 'members' => [ 'latencyMs' => [ 'shape' => 'Long', ], ], ], 'ConverseStreamOutput' => [ 'type' => 'structure', 'members' => [ 'messageStart' => [ 'shape' => 'MessageStartEvent', ], 'contentBlockStart' => [ 'shape' => 'ContentBlockStartEvent', ], 'contentBlockDelta' => [ 'shape' => 'ContentBlockDeltaEvent', ], 'contentBlockStop' => [ 'shape' => 'ContentBlockStopEvent', ], 'messageStop' => [ 'shape' => 'MessageStopEvent', ], 'metadata' => [ 'shape' => 'ConverseStreamMetadataEvent', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'modelStreamErrorException' => [ 'shape' => 'ModelStreamErrorException', ], 'validationException' => [ 'shape' => 'ValidationException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'serviceUnavailableException' => [ 'shape' => 'ServiceUnavailableException', ], ], 'eventstream' => true, ], 'ConverseStreamRequest' => [ 'type' => 'structure', 'required' => [ 'modelId', 'messages', ], 'members' => [ 'modelId' => [ 'shape' => 'ConversationalModelId', 'location' => 'uri', 'locationName' => 'modelId', ], 'messages' => [ 'shape' => 'Messages', ], 'system' => [ 'shape' => 'SystemContentBlocks', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfiguration', ], 'toolConfig' => [ 'shape' => 'ToolConfiguration', ], 'guardrailConfig' => [ 'shape' => 'GuardrailStreamConfiguration', ], 'additionalModelRequestFields' => [ 'shape' => 'Document', ], 'additionalModelResponseFieldPaths' => [ 'shape' => 'ConverseStreamRequestAdditionalModelResponseFieldPathsList', ], ], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString', ], 'max' => 10, 'min' => 0, ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ConverseStreamResponse' => [ 'type' => 'structure', 'members' => [ 'stream' => [ 'shape' => 'ConverseStreamOutput', ], ], 'payload' => 'stream', ], 'ConverseStreamTrace' => [ 'type' => 'structure', 'members' => [ 'guardrail' => [ 'shape' => 'GuardrailTraceAssessment', ], ], ], 'ConverseTrace' => [ 'type' => 'structure', 'members' => [ 'guardrail' => [ 'shape' => 'GuardrailTraceAssessment', ], ], ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DocumentBlock' => [ 'type' => 'structure', 'required' => [ 'format', 'name', 'source', ], 'members' => [ 'format' => [ 'shape' => 'DocumentFormat', ], 'name' => [ 'shape' => 'DocumentBlockNameString', ], 'source' => [ 'shape' => 'DocumentSource', ], ], ], 'DocumentBlockNameString' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'DocumentFormat' => [ 'type' => 'string', 'enum' => [ 'pdf', 'csv', 'doc', 'docx', 'xls', 'xlsx', 'html', 'txt', 'md', ], ], 'DocumentSource' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'DocumentSourceBytesBlob', ], ], 'union' => true, ], 'DocumentSourceBytesBlob' => [ 'type' => 'blob', 'min' => 1, ], 'GuardrailAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'GUARDRAIL_INTERVENED', ], ], 'GuardrailAssessment' => [ 'type' => 'structure', 'members' => [ 'topicPolicy' => [ 'shape' => 'GuardrailTopicPolicyAssessment', ], 'contentPolicy' => [ 'shape' => 'GuardrailContentPolicyAssessment', ], 'wordPolicy' => [ 'shape' => 'GuardrailWordPolicyAssessment', ], 'sensitiveInformationPolicy' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAssessment', ], 'contextualGroundingPolicy' => [ 'shape' => 'GuardrailContextualGroundingPolicyAssessment', ], ], ], 'GuardrailAssessmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailAssessmentListMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'GuardrailAssessmentList', ], ], 'GuardrailAssessmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', ], 'trace' => [ 'shape' => 'GuardrailTrace', ], ], ], 'GuardrailContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailTextBlock', ], ], 'union' => true, ], 'GuardrailContentBlockList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentBlock', ], ], 'GuardrailContentFilter' => [ 'type' => 'structure', 'required' => [ 'type', 'confidence', 'action', ], 'members' => [ 'type' => [ 'shape' => 'GuardrailContentFilterType', ], 'confidence' => [ 'shape' => 'GuardrailContentFilterConfidence', ], 'action' => [ 'shape' => 'GuardrailContentPolicyAction', ], ], ], 'GuardrailContentFilterConfidence' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', ], ], 'GuardrailContentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentFilter', ], ], 'GuardrailContentFilterType' => [ 'type' => 'string', 'enum' => [ 'INSULTS', 'HATE', 'SEXUAL', 'VIOLENCE', 'MISCONDUCT', 'PROMPT_ATTACK', ], ], 'GuardrailContentPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailContentPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'filters', ], 'members' => [ 'filters' => [ 'shape' => 'GuardrailContentFilterList', ], ], ], 'GuardrailContentPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailContentQualifier' => [ 'type' => 'string', 'enum' => [ 'grounding_source', 'query', 'guard_content', ], ], 'GuardrailContentQualifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentQualifier', ], ], 'GuardrailContentSource' => [ 'type' => 'string', 'enum' => [ 'INPUT', 'OUTPUT', ], ], 'GuardrailContextualGroundingFilter' => [ 'type' => 'structure', 'required' => [ 'type', 'threshold', 'score', 'action', ], 'members' => [ 'type' => [ 'shape' => 'GuardrailContextualGroundingFilterType', ], 'threshold' => [ 'shape' => 'GuardrailContextualGroundingFilterThresholdDouble', ], 'score' => [ 'shape' => 'GuardrailContextualGroundingFilterScoreDouble', ], 'action' => [ 'shape' => 'GuardrailContextualGroundingPolicyAction', ], ], ], 'GuardrailContextualGroundingFilterScoreDouble' => [ 'type' => 'double', 'box' => true, 'max' => 1, 'min' => 0, ], 'GuardrailContextualGroundingFilterThresholdDouble' => [ 'type' => 'double', 'box' => true, 'max' => 1, 'min' => 0, ], 'GuardrailContextualGroundingFilterType' => [ 'type' => 'string', 'enum' => [ 'GROUNDING', 'RELEVANCE', ], ], 'GuardrailContextualGroundingFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContextualGroundingFilter', ], ], 'GuardrailContextualGroundingPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', 'NONE', ], ], 'GuardrailContextualGroundingPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'GuardrailContextualGroundingFilters', ], ], ], 'GuardrailContextualGroundingPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailConverseContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailConverseTextBlock', ], ], 'union' => true, ], 'GuardrailConverseContentQualifier' => [ 'type' => 'string', 'enum' => [ 'grounding_source', 'query', 'guard_content', ], ], 'GuardrailConverseContentQualifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailConverseContentQualifier', ], ], 'GuardrailConverseTextBlock' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], 'qualifiers' => [ 'shape' => 'GuardrailConverseContentQualifierList', ], ], ], 'GuardrailCustomWord' => [ 'type' => 'structure', 'required' => [ 'match', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], ], ], 'GuardrailCustomWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailCustomWord', ], ], 'GuardrailIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))', ], 'GuardrailManagedWord' => [ 'type' => 'structure', 'required' => [ 'match', 'type', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailManagedWordType', ], 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], ], ], 'GuardrailManagedWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailManagedWord', ], ], 'GuardrailManagedWordType' => [ 'type' => 'string', 'enum' => [ 'PROFANITY', ], ], 'GuardrailOutputContent' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailOutputText', ], ], ], 'GuardrailOutputContentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailOutputContent', ], ], 'GuardrailOutputText' => [ 'type' => 'string', ], 'GuardrailPiiEntityFilter' => [ 'type' => 'structure', 'required' => [ 'match', 'type', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailPiiEntityType', ], 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], ], ], 'GuardrailPiiEntityFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailPiiEntityFilter', ], ], 'GuardrailPiiEntityType' => [ 'type' => 'string', 'enum' => [ 'ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER', ], ], 'GuardrailRegexFilter' => [ 'type' => 'structure', 'required' => [ 'action', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'match' => [ 'shape' => 'String', ], 'regex' => [ 'shape' => 'String', ], 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], ], ], 'GuardrailRegexFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailRegexFilter', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'type' => 'string', 'enum' => [ 'ANONYMIZED', 'BLOCKED', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'piiEntities', 'regexes', ], 'members' => [ 'piiEntities' => [ 'shape' => 'GuardrailPiiEntityFilterList', ], 'regexes' => [ 'shape' => 'GuardrailRegexFilterList', ], ], ], 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailSensitiveInformationPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailStreamConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', ], 'trace' => [ 'shape' => 'GuardrailTrace', ], 'streamProcessingMode' => [ 'shape' => 'GuardrailStreamProcessingMode', ], ], ], 'GuardrailStreamProcessingMode' => [ 'type' => 'string', 'enum' => [ 'sync', 'async', ], ], 'GuardrailTextBlock' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], 'qualifiers' => [ 'shape' => 'GuardrailContentQualifierList', ], ], ], 'GuardrailTopic' => [ 'type' => 'structure', 'required' => [ 'name', 'type', 'action', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailTopicType', ], 'action' => [ 'shape' => 'GuardrailTopicPolicyAction', ], ], ], 'GuardrailTopicList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailTopic', ], ], 'GuardrailTopicPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailTopicPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'topics', ], 'members' => [ 'topics' => [ 'shape' => 'GuardrailTopicList', ], ], ], 'GuardrailTopicPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailTopicType' => [ 'type' => 'string', 'enum' => [ 'DENY', ], ], 'GuardrailTrace' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'GuardrailTraceAssessment' => [ 'type' => 'structure', 'members' => [ 'modelOutput' => [ 'shape' => 'ModelOutputs', ], 'inputAssessment' => [ 'shape' => 'GuardrailAssessmentMap', ], 'outputAssessments' => [ 'shape' => 'GuardrailAssessmentListMap', ], ], ], 'GuardrailUsage' => [ 'type' => 'structure', 'required' => [ 'topicPolicyUnits', 'contentPolicyUnits', 'wordPolicyUnits', 'sensitiveInformationPolicyUnits', 'sensitiveInformationPolicyFreeUnits', 'contextualGroundingPolicyUnits', ], 'members' => [ 'topicPolicyUnits' => [ 'shape' => 'GuardrailTopicPolicyUnitsProcessed', ], 'contentPolicyUnits' => [ 'shape' => 'GuardrailContentPolicyUnitsProcessed', ], 'wordPolicyUnits' => [ 'shape' => 'GuardrailWordPolicyUnitsProcessed', ], 'sensitiveInformationPolicyUnits' => [ 'shape' => 'GuardrailSensitiveInformationPolicyUnitsProcessed', ], 'sensitiveInformationPolicyFreeUnits' => [ 'shape' => 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed', ], 'contextualGroundingPolicyUnits' => [ 'shape' => 'GuardrailContextualGroundingPolicyUnitsProcessed', ], ], ], 'GuardrailVersion' => [ 'type' => 'string', 'pattern' => '(([1-9][0-9]{0,7})|(DRAFT))', ], 'GuardrailWordPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailWordPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'customWords', 'managedWordLists', ], 'members' => [ 'customWords' => [ 'shape' => 'GuardrailCustomWordList', ], 'managedWordLists' => [ 'shape' => 'GuardrailManagedWordList', ], ], ], 'GuardrailWordPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'ImageBlock' => [ 'type' => 'structure', 'required' => [ 'format', 'source', ], 'members' => [ 'format' => [ 'shape' => 'ImageFormat', ], 'source' => [ 'shape' => 'ImageSource', ], ], ], 'ImageFormat' => [ 'type' => 'string', 'enum' => [ 'png', 'jpeg', 'gif', 'webp', ], ], 'ImageSource' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'ImageSourceBytesBlob', ], ], 'union' => true, ], 'ImageSourceBytesBlob' => [ 'type' => 'blob', 'min' => 1, ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maxTokens' => [ 'shape' => 'InferenceConfigurationMaxTokensInteger', ], 'temperature' => [ 'shape' => 'InferenceConfigurationTemperatureFloat', ], 'topP' => [ 'shape' => 'InferenceConfigurationTopPFloat', ], 'stopSequences' => [ 'shape' => 'InferenceConfigurationStopSequencesList', ], ], ], 'InferenceConfigurationMaxTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'InferenceConfigurationStopSequencesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'max' => 4, 'min' => 0, ], 'InferenceConfigurationTemperatureFloat' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'InferenceConfigurationTopPFloat' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvokeModelIdentifier' => [ '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})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)', ], 'InvokeModelRequest' => [ 'type' => 'structure', 'required' => [ 'body', 'modelId', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'accept' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Accept', ], 'modelId' => [ 'shape' => 'InvokeModelIdentifier', 'location' => 'uri', 'locationName' => 'modelId', ], 'trace' => [ 'shape' => 'Trace', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Trace', ], 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailVersion', ], ], 'payload' => 'body', ], 'InvokeModelResponse' => [ 'type' => 'structure', 'required' => [ 'body', 'contentType', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], ], 'payload' => 'body', ], 'InvokeModelWithResponseStreamRequest' => [ 'type' => 'structure', 'required' => [ 'body', 'modelId', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'accept' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Accept', ], 'modelId' => [ 'shape' => 'InvokeModelIdentifier', 'location' => 'uri', 'locationName' => 'modelId', ], 'trace' => [ 'shape' => 'Trace', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Trace', ], 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailVersion', ], ], 'payload' => 'body', ], 'InvokeModelWithResponseStreamResponse' => [ 'type' => 'structure', 'required' => [ 'body', 'contentType', ], 'members' => [ 'body' => [ 'shape' => 'ResponseStream', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Content-Type', ], ], 'payload' => 'body', ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'Message' => [ 'type' => 'structure', 'required' => [ 'role', 'content', ], 'members' => [ 'role' => [ 'shape' => 'ConversationRole', ], 'content' => [ 'shape' => 'ContentBlocks', ], ], ], 'MessageStartEvent' => [ 'type' => 'structure', 'required' => [ 'role', ], 'members' => [ 'role' => [ 'shape' => 'ConversationRole', ], ], 'event' => true, ], 'MessageStopEvent' => [ 'type' => 'structure', 'required' => [ 'stopReason', ], 'members' => [ 'stopReason' => [ 'shape' => 'StopReason', ], 'additionalModelResponseFields' => [ 'shape' => 'Document', ], ], 'event' => true, ], 'Messages' => [ 'type' => 'list', 'member' => [ 'shape' => 'Message', ], ], 'MimeType' => [ 'type' => 'string', ], 'ModelErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'originalStatusCode' => [ 'shape' => 'StatusCode', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'ModelNotReadyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'ModelOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailOutputText', ], ], 'ModelStreamErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'originalStatusCode' => [ 'shape' => 'StatusCode', ], 'originalMessage' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'ModelTimeoutException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '[\\s\\S]*', ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], 'NonNegativeInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'PartBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'PayloadPart' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'PartBody', ], ], 'event' => true, 'sensitive' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseStream' => [ 'type' => 'structure', 'members' => [ 'chunk' => [ 'shape' => 'PayloadPart', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'modelStreamErrorException' => [ 'shape' => 'ModelStreamErrorException', ], 'validationException' => [ 'shape' => 'ValidationException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'modelTimeoutException' => [ 'shape' => 'ModelTimeoutException', ], 'serviceUnavailableException' => [ 'shape' => 'ServiceUnavailableException', ], ], 'eventstream' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SpecificToolChoice' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ToolName', ], ], ], 'StatusCode' => [ 'type' => 'integer', 'box' => true, 'max' => 599, 'min' => 100, ], 'StopReason' => [ 'type' => 'string', 'enum' => [ 'end_turn', 'tool_use', 'max_tokens', 'stop_sequence', 'guardrail_intervened', 'content_filtered', ], ], 'String' => [ 'type' => 'string', ], 'SystemContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'NonEmptyString', ], 'guardContent' => [ 'shape' => 'GuardrailConverseContentBlock', ], ], 'union' => true, ], 'SystemContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemContentBlock', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TokenUsage' => [ 'type' => 'structure', 'required' => [ 'inputTokens', 'outputTokens', 'totalTokens', ], 'members' => [ 'inputTokens' => [ 'shape' => 'TokenUsageInputTokensInteger', ], 'outputTokens' => [ 'shape' => 'TokenUsageOutputTokensInteger', ], 'totalTokens' => [ 'shape' => 'TokenUsageTotalTokensInteger', ], ], ], 'TokenUsageInputTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TokenUsageOutputTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TokenUsageTotalTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'Tool' => [ 'type' => 'structure', 'members' => [ 'toolSpec' => [ 'shape' => 'ToolSpecification', ], ], 'union' => true, ], 'ToolChoice' => [ 'type' => 'structure', 'members' => [ 'auto' => [ 'shape' => 'AutoToolChoice', ], 'any' => [ 'shape' => 'AnyToolChoice', ], 'tool' => [ 'shape' => 'SpecificToolChoice', ], ], 'union' => true, ], 'ToolConfiguration' => [ 'type' => 'structure', 'required' => [ 'tools', ], 'members' => [ 'tools' => [ 'shape' => 'ToolConfigurationToolsList', ], 'toolChoice' => [ 'shape' => 'ToolChoice', ], ], ], 'ToolConfigurationToolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tool', ], 'min' => 1, ], 'ToolInputSchema' => [ 'type' => 'structure', 'members' => [ 'json' => [ 'shape' => 'Document', ], ], 'union' => true, ], 'ToolName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9_]*', ], 'ToolResultBlock' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'content', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'content' => [ 'shape' => 'ToolResultContentBlocks', ], 'status' => [ 'shape' => 'ToolResultStatus', ], ], ], 'ToolResultContentBlock' => [ 'type' => 'structure', 'members' => [ 'json' => [ 'shape' => 'Document', ], 'text' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'ImageBlock', ], 'document' => [ 'shape' => 'DocumentBlock', ], ], 'union' => true, ], 'ToolResultContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ToolResultContentBlock', ], ], 'ToolResultStatus' => [ 'type' => 'string', 'enum' => [ 'success', 'error', ], ], 'ToolSpecification' => [ 'type' => 'structure', 'required' => [ 'name', 'inputSchema', ], 'members' => [ 'name' => [ 'shape' => 'ToolName', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'inputSchema' => [ 'shape' => 'ToolInputSchema', ], ], ], 'ToolUseBlock' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'name', 'input', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'name' => [ 'shape' => 'ToolName', ], 'input' => [ 'shape' => 'Document', ], ], ], 'ToolUseBlockDelta' => [ 'type' => 'structure', 'required' => [ 'input', ], 'members' => [ 'input' => [ 'shape' => 'String', ], ], ], 'ToolUseBlockStart' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'name', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'name' => [ 'shape' => 'ToolName', ], ], ], 'ToolUseId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'Trace' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2023-09-30', 'auth' => [ 'aws.auth#sigv4', ], 'endpointPrefix' => 'bedrock-runtime', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon Bedrock Runtime', 'serviceId' => 'Bedrock Runtime', 'signatureVersion' => 'v4', 'signingName' => 'bedrock', 'uid' => 'bedrock-runtime-2023-09-30', ], 'operations' => [ 'ApplyGuardrail' => [ 'name' => 'ApplyGuardrail', 'http' => [ 'method' => 'POST', 'requestUri' => '/guardrail/{guardrailIdentifier}/version/{guardrailVersion}/apply', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ApplyGuardrailRequest', ], 'output' => [ 'shape' => 'ApplyGuardrailResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'Converse' => [ 'name' => 'Converse', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/converse', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ConverseRequest', ], 'output' => [ 'shape' => 'ConverseResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'ConverseStream' => [ 'name' => 'ConverseStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/converse-stream', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ConverseStreamRequest', ], 'output' => [ 'shape' => 'ConverseStreamResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'InvokeModel' => [ 'name' => 'InvokeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/invoke', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeModelRequest', ], 'output' => [ 'shape' => 'InvokeModelResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ModelErrorException', ], ], ], 'InvokeModelWithResponseStream' => [ 'name' => 'InvokeModelWithResponseStream', 'http' => [ 'method' => 'POST', 'requestUri' => '/model/{modelId}/invoke-with-response-stream', 'responseCode' => 200, ], 'input' => [ 'shape' => 'InvokeModelWithResponseStreamRequest', ], 'output' => [ 'shape' => 'InvokeModelWithResponseStreamResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ModelTimeoutException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'ModelStreamErrorException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ModelNotReadyException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ModelErrorException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AnyToolChoice' => [ 'type' => 'structure', 'members' => [], ], 'ApplyGuardrailRequest' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', 'source', 'content', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'uri', 'locationName' => 'guardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'uri', 'locationName' => 'guardrailVersion', ], 'source' => [ 'shape' => 'GuardrailContentSource', ], 'content' => [ 'shape' => 'GuardrailContentBlockList', ], ], ], 'ApplyGuardrailResponse' => [ 'type' => 'structure', 'required' => [ 'usage', 'action', 'outputs', 'assessments', ], 'members' => [ 'usage' => [ 'shape' => 'GuardrailUsage', ], 'action' => [ 'shape' => 'GuardrailAction', ], 'outputs' => [ 'shape' => 'GuardrailOutputContentList', ], 'assessments' => [ 'shape' => 'GuardrailAssessmentList', ], ], ], 'AutoToolChoice' => [ 'type' => 'structure', 'members' => [], ], 'Body' => [ 'type' => 'blob', 'max' => 25000000, 'min' => 0, 'sensitive' => true, ], 'ContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'ImageBlock', ], 'document' => [ 'shape' => 'DocumentBlock', ], 'toolUse' => [ 'shape' => 'ToolUseBlock', ], 'toolResult' => [ 'shape' => 'ToolResultBlock', ], 'guardContent' => [ 'shape' => 'GuardrailConverseContentBlock', ], ], 'union' => true, ], 'ContentBlockDelta' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'toolUse' => [ 'shape' => 'ToolUseBlockDelta', ], ], 'union' => true, ], 'ContentBlockDeltaEvent' => [ 'type' => 'structure', 'required' => [ 'delta', 'contentBlockIndex', ], 'members' => [ 'delta' => [ 'shape' => 'ContentBlockDelta', ], 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlockStart' => [ 'type' => 'structure', 'members' => [ 'toolUse' => [ 'shape' => 'ToolUseBlockStart', ], ], 'union' => true, ], 'ContentBlockStartEvent' => [ 'type' => 'structure', 'required' => [ 'start', 'contentBlockIndex', ], 'members' => [ 'start' => [ 'shape' => 'ContentBlockStart', ], 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlockStopEvent' => [ 'type' => 'structure', 'required' => [ 'contentBlockIndex', ], 'members' => [ 'contentBlockIndex' => [ 'shape' => 'NonNegativeInteger', ], ], 'event' => true, ], 'ContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentBlock', ], ], 'ConversationRole' => [ 'type' => 'string', 'enum' => [ 'user', 'assistant', ], ], 'ConversationalModelId' => [ '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})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)', ], 'ConverseMetrics' => [ 'type' => 'structure', 'required' => [ 'latencyMs', ], 'members' => [ 'latencyMs' => [ 'shape' => 'Long', ], ], ], 'ConverseOutput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'union' => true, ], 'ConverseRequest' => [ 'type' => 'structure', 'required' => [ 'modelId', 'messages', ], 'members' => [ 'modelId' => [ 'shape' => 'ConversationalModelId', 'location' => 'uri', 'locationName' => 'modelId', ], 'messages' => [ 'shape' => 'Messages', ], 'system' => [ 'shape' => 'SystemContentBlocks', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfiguration', ], 'toolConfig' => [ 'shape' => 'ToolConfiguration', ], 'guardrailConfig' => [ 'shape' => 'GuardrailConfiguration', ], 'additionalModelRequestFields' => [ 'shape' => 'Document', ], 'additionalModelResponseFieldPaths' => [ 'shape' => 'ConverseRequestAdditionalModelResponseFieldPathsList', ], ], ], 'ConverseRequestAdditionalModelResponseFieldPathsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString', ], 'max' => 10, 'min' => 0, ], 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ConverseResponse' => [ 'type' => 'structure', 'required' => [ 'output', 'stopReason', 'usage', 'metrics', ], 'members' => [ 'output' => [ 'shape' => 'ConverseOutput', ], 'stopReason' => [ 'shape' => 'StopReason', ], 'usage' => [ 'shape' => 'TokenUsage', ], 'metrics' => [ 'shape' => 'ConverseMetrics', ], 'additionalModelResponseFields' => [ 'shape' => 'Document', ], 'trace' => [ 'shape' => 'ConverseTrace', ], ], ], 'ConverseStreamMetadataEvent' => [ 'type' => 'structure', 'required' => [ 'usage', 'metrics', ], 'members' => [ 'usage' => [ 'shape' => 'TokenUsage', ], 'metrics' => [ 'shape' => 'ConverseStreamMetrics', ], 'trace' => [ 'shape' => 'ConverseStreamTrace', ], ], 'event' => true, ], 'ConverseStreamMetrics' => [ 'type' => 'structure', 'required' => [ 'latencyMs', ], 'members' => [ 'latencyMs' => [ 'shape' => 'Long', ], ], ], 'ConverseStreamOutput' => [ 'type' => 'structure', 'members' => [ 'messageStart' => [ 'shape' => 'MessageStartEvent', ], 'contentBlockStart' => [ 'shape' => 'ContentBlockStartEvent', ], 'contentBlockDelta' => [ 'shape' => 'ContentBlockDeltaEvent', ], 'contentBlockStop' => [ 'shape' => 'ContentBlockStopEvent', ], 'messageStop' => [ 'shape' => 'MessageStopEvent', ], 'metadata' => [ 'shape' => 'ConverseStreamMetadataEvent', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'modelStreamErrorException' => [ 'shape' => 'ModelStreamErrorException', ], 'validationException' => [ 'shape' => 'ValidationException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'serviceUnavailableException' => [ 'shape' => 'ServiceUnavailableException', ], ], 'eventstream' => true, ], 'ConverseStreamRequest' => [ 'type' => 'structure', 'required' => [ 'modelId', 'messages', ], 'members' => [ 'modelId' => [ 'shape' => 'ConversationalModelId', 'location' => 'uri', 'locationName' => 'modelId', ], 'messages' => [ 'shape' => 'Messages', ], 'system' => [ 'shape' => 'SystemContentBlocks', ], 'inferenceConfig' => [ 'shape' => 'InferenceConfiguration', ], 'toolConfig' => [ 'shape' => 'ToolConfiguration', ], 'guardrailConfig' => [ 'shape' => 'GuardrailStreamConfiguration', ], 'additionalModelRequestFields' => [ 'shape' => 'Document', ], 'additionalModelResponseFieldPaths' => [ 'shape' => 'ConverseStreamRequestAdditionalModelResponseFieldPathsList', ], ], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString', ], 'max' => 10, 'min' => 0, ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ConverseStreamResponse' => [ 'type' => 'structure', 'members' => [ 'stream' => [ 'shape' => 'ConverseStreamOutput', ], ], 'payload' => 'stream', ], 'ConverseStreamTrace' => [ 'type' => 'structure', 'members' => [ 'guardrail' => [ 'shape' => 'GuardrailTraceAssessment', ], ], ], 'ConverseTrace' => [ 'type' => 'structure', 'members' => [ 'guardrail' => [ 'shape' => 'GuardrailTraceAssessment', ], ], ], 'Document' => [ 'type' => 'structure', 'members' => [], 'document' => true, ], 'DocumentBlock' => [ 'type' => 'structure', 'required' => [ 'format', 'name', 'source', ], 'members' => [ 'format' => [ 'shape' => 'DocumentFormat', ], 'name' => [ 'shape' => 'DocumentBlockNameString', ], 'source' => [ 'shape' => 'DocumentSource', ], ], ], 'DocumentBlockNameString' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'DocumentFormat' => [ 'type' => 'string', 'enum' => [ 'pdf', 'csv', 'doc', 'docx', 'xls', 'xlsx', 'html', 'txt', 'md', ], ], 'DocumentSource' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'DocumentSourceBytesBlob', ], ], 'union' => true, ], 'DocumentSourceBytesBlob' => [ 'type' => 'blob', 'min' => 1, ], 'GuardrailAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'GUARDRAIL_INTERVENED', ], ], 'GuardrailAssessment' => [ 'type' => 'structure', 'members' => [ 'topicPolicy' => [ 'shape' => 'GuardrailTopicPolicyAssessment', ], 'contentPolicy' => [ 'shape' => 'GuardrailContentPolicyAssessment', ], 'wordPolicy' => [ 'shape' => 'GuardrailWordPolicyAssessment', ], 'sensitiveInformationPolicy' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAssessment', ], 'contextualGroundingPolicy' => [ 'shape' => 'GuardrailContextualGroundingPolicyAssessment', ], ], ], 'GuardrailAssessmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailAssessmentListMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'GuardrailAssessmentList', ], ], 'GuardrailAssessmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'GuardrailAssessment', ], ], 'GuardrailConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', ], 'trace' => [ 'shape' => 'GuardrailTrace', ], ], ], 'GuardrailContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailTextBlock', ], ], 'union' => true, ], 'GuardrailContentBlockList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentBlock', ], ], 'GuardrailContentFilter' => [ 'type' => 'structure', 'required' => [ 'type', 'confidence', 'action', ], 'members' => [ 'type' => [ 'shape' => 'GuardrailContentFilterType', ], 'confidence' => [ 'shape' => 'GuardrailContentFilterConfidence', ], 'action' => [ 'shape' => 'GuardrailContentPolicyAction', ], ], ], 'GuardrailContentFilterConfidence' => [ 'type' => 'string', 'enum' => [ 'NONE', 'LOW', 'MEDIUM', 'HIGH', ], ], 'GuardrailContentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentFilter', ], ], 'GuardrailContentFilterType' => [ 'type' => 'string', 'enum' => [ 'INSULTS', 'HATE', 'SEXUAL', 'VIOLENCE', 'MISCONDUCT', 'PROMPT_ATTACK', ], ], 'GuardrailContentPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailContentPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'filters', ], 'members' => [ 'filters' => [ 'shape' => 'GuardrailContentFilterList', ], ], ], 'GuardrailContentPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailContentQualifier' => [ 'type' => 'string', 'enum' => [ 'grounding_source', 'query', 'guard_content', ], ], 'GuardrailContentQualifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContentQualifier', ], ], 'GuardrailContentSource' => [ 'type' => 'string', 'enum' => [ 'INPUT', 'OUTPUT', ], ], 'GuardrailContextualGroundingFilter' => [ 'type' => 'structure', 'required' => [ 'type', 'threshold', 'score', 'action', ], 'members' => [ 'type' => [ 'shape' => 'GuardrailContextualGroundingFilterType', ], 'threshold' => [ 'shape' => 'GuardrailContextualGroundingFilterThresholdDouble', ], 'score' => [ 'shape' => 'GuardrailContextualGroundingFilterScoreDouble', ], 'action' => [ 'shape' => 'GuardrailContextualGroundingPolicyAction', ], ], ], 'GuardrailContextualGroundingFilterScoreDouble' => [ 'type' => 'double', 'box' => true, 'max' => 1, 'min' => 0, ], 'GuardrailContextualGroundingFilterThresholdDouble' => [ 'type' => 'double', 'box' => true, 'max' => 1, 'min' => 0, ], 'GuardrailContextualGroundingFilterType' => [ 'type' => 'string', 'enum' => [ 'GROUNDING', 'RELEVANCE', ], ], 'GuardrailContextualGroundingFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailContextualGroundingFilter', ], ], 'GuardrailContextualGroundingPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', 'NONE', ], ], 'GuardrailContextualGroundingPolicyAssessment' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'GuardrailContextualGroundingFilters', ], ], ], 'GuardrailContextualGroundingPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailConverseContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailConverseTextBlock', ], ], 'union' => true, ], 'GuardrailConverseContentQualifier' => [ 'type' => 'string', 'enum' => [ 'grounding_source', 'query', 'guard_content', ], ], 'GuardrailConverseContentQualifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailConverseContentQualifier', ], ], 'GuardrailConverseTextBlock' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], 'qualifiers' => [ 'shape' => 'GuardrailConverseContentQualifierList', ], ], ], 'GuardrailCustomWord' => [ 'type' => 'structure', 'required' => [ 'match', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], ], ], 'GuardrailCustomWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailCustomWord', ], ], 'GuardrailIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))', ], 'GuardrailManagedWord' => [ 'type' => 'structure', 'required' => [ 'match', 'type', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailManagedWordType', ], 'action' => [ 'shape' => 'GuardrailWordPolicyAction', ], ], ], 'GuardrailManagedWordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailManagedWord', ], ], 'GuardrailManagedWordType' => [ 'type' => 'string', 'enum' => [ 'PROFANITY', ], ], 'GuardrailOutputContent' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'GuardrailOutputText', ], ], ], 'GuardrailOutputContentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailOutputContent', ], ], 'GuardrailOutputText' => [ 'type' => 'string', ], 'GuardrailPiiEntityFilter' => [ 'type' => 'structure', 'required' => [ 'match', 'type', 'action', ], 'members' => [ 'match' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailPiiEntityType', ], 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], ], ], 'GuardrailPiiEntityFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailPiiEntityFilter', ], ], 'GuardrailPiiEntityType' => [ 'type' => 'string', 'enum' => [ 'ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER', ], ], 'GuardrailRegexFilter' => [ 'type' => 'structure', 'required' => [ 'action', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'match' => [ 'shape' => 'String', ], 'regex' => [ 'shape' => 'String', ], 'action' => [ 'shape' => 'GuardrailSensitiveInformationPolicyAction', ], ], ], 'GuardrailRegexFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailRegexFilter', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'type' => 'string', 'enum' => [ 'ANONYMIZED', 'BLOCKED', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'piiEntities', 'regexes', ], 'members' => [ 'piiEntities' => [ 'shape' => 'GuardrailPiiEntityFilterList', ], 'regexes' => [ 'shape' => 'GuardrailRegexFilterList', ], ], ], 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailSensitiveInformationPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailStreamConfiguration' => [ 'type' => 'structure', 'required' => [ 'guardrailIdentifier', 'guardrailVersion', ], 'members' => [ 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', ], 'trace' => [ 'shape' => 'GuardrailTrace', ], 'streamProcessingMode' => [ 'shape' => 'GuardrailStreamProcessingMode', ], ], ], 'GuardrailStreamProcessingMode' => [ 'type' => 'string', 'enum' => [ 'sync', 'async', ], ], 'GuardrailTextBlock' => [ 'type' => 'structure', 'required' => [ 'text', ], 'members' => [ 'text' => [ 'shape' => 'String', ], 'qualifiers' => [ 'shape' => 'GuardrailContentQualifierList', ], ], ], 'GuardrailTopic' => [ 'type' => 'structure', 'required' => [ 'name', 'type', 'action', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'GuardrailTopicType', ], 'action' => [ 'shape' => 'GuardrailTopicPolicyAction', ], ], ], 'GuardrailTopicList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailTopic', ], ], 'GuardrailTopicPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailTopicPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'topics', ], 'members' => [ 'topics' => [ 'shape' => 'GuardrailTopicList', ], ], ], 'GuardrailTopicPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'GuardrailTopicType' => [ 'type' => 'string', 'enum' => [ 'DENY', ], ], 'GuardrailTrace' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'GuardrailTraceAssessment' => [ 'type' => 'structure', 'members' => [ 'modelOutput' => [ 'shape' => 'ModelOutputs', ], 'inputAssessment' => [ 'shape' => 'GuardrailAssessmentMap', ], 'outputAssessments' => [ 'shape' => 'GuardrailAssessmentListMap', ], ], ], 'GuardrailUsage' => [ 'type' => 'structure', 'required' => [ 'topicPolicyUnits', 'contentPolicyUnits', 'wordPolicyUnits', 'sensitiveInformationPolicyUnits', 'sensitiveInformationPolicyFreeUnits', 'contextualGroundingPolicyUnits', ], 'members' => [ 'topicPolicyUnits' => [ 'shape' => 'GuardrailTopicPolicyUnitsProcessed', ], 'contentPolicyUnits' => [ 'shape' => 'GuardrailContentPolicyUnitsProcessed', ], 'wordPolicyUnits' => [ 'shape' => 'GuardrailWordPolicyUnitsProcessed', ], 'sensitiveInformationPolicyUnits' => [ 'shape' => 'GuardrailSensitiveInformationPolicyUnitsProcessed', ], 'sensitiveInformationPolicyFreeUnits' => [ 'shape' => 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed', ], 'contextualGroundingPolicyUnits' => [ 'shape' => 'GuardrailContextualGroundingPolicyUnitsProcessed', ], ], ], 'GuardrailVersion' => [ 'type' => 'string', 'pattern' => '(([1-9][0-9]{0,7})|(DRAFT))', ], 'GuardrailWordPolicyAction' => [ 'type' => 'string', 'enum' => [ 'BLOCKED', ], ], 'GuardrailWordPolicyAssessment' => [ 'type' => 'structure', 'required' => [ 'customWords', 'managedWordLists', ], 'members' => [ 'customWords' => [ 'shape' => 'GuardrailCustomWordList', ], 'managedWordLists' => [ 'shape' => 'GuardrailManagedWordList', ], ], ], 'GuardrailWordPolicyUnitsProcessed' => [ 'type' => 'integer', 'box' => true, ], 'ImageBlock' => [ 'type' => 'structure', 'required' => [ 'format', 'source', ], 'members' => [ 'format' => [ 'shape' => 'ImageFormat', ], 'source' => [ 'shape' => 'ImageSource', ], ], ], 'ImageFormat' => [ 'type' => 'string', 'enum' => [ 'png', 'jpeg', 'gif', 'webp', ], ], 'ImageSource' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'ImageSourceBytesBlob', ], ], 'union' => true, ], 'ImageSourceBytesBlob' => [ 'type' => 'blob', 'min' => 1, ], 'InferenceConfiguration' => [ 'type' => 'structure', 'members' => [ 'maxTokens' => [ 'shape' => 'InferenceConfigurationMaxTokensInteger', ], 'temperature' => [ 'shape' => 'InferenceConfigurationTemperatureFloat', ], 'topP' => [ 'shape' => 'InferenceConfigurationTopPFloat', ], 'stopSequences' => [ 'shape' => 'InferenceConfigurationStopSequencesList', ], ], ], 'InferenceConfigurationMaxTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'InferenceConfigurationStopSequencesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'max' => 4, 'min' => 0, ], 'InferenceConfigurationTemperatureFloat' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'InferenceConfigurationTopPFloat' => [ 'type' => 'float', 'box' => true, 'max' => 1, 'min' => 0, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvokeModelIdentifier' => [ '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}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)', ], 'InvokeModelRequest' => [ 'type' => 'structure', 'required' => [ 'body', 'modelId', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'accept' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Accept', ], 'modelId' => [ 'shape' => 'InvokeModelIdentifier', 'location' => 'uri', 'locationName' => 'modelId', ], 'trace' => [ 'shape' => 'Trace', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Trace', ], 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailVersion', ], ], 'payload' => 'body', ], 'InvokeModelResponse' => [ 'type' => 'structure', 'required' => [ 'body', 'contentType', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], ], 'payload' => 'body', ], 'InvokeModelWithResponseStreamRequest' => [ 'type' => 'structure', 'required' => [ 'body', 'modelId', ], 'members' => [ 'body' => [ 'shape' => 'Body', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'accept' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Accept', ], 'modelId' => [ 'shape' => 'InvokeModelIdentifier', 'location' => 'uri', 'locationName' => 'modelId', ], 'trace' => [ 'shape' => 'Trace', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Trace', ], 'guardrailIdentifier' => [ 'shape' => 'GuardrailIdentifier', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailIdentifier', ], 'guardrailVersion' => [ 'shape' => 'GuardrailVersion', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-GuardrailVersion', ], ], 'payload' => 'body', ], 'InvokeModelWithResponseStreamResponse' => [ 'type' => 'structure', 'required' => [ 'body', 'contentType', ], 'members' => [ 'body' => [ 'shape' => 'ResponseStream', ], 'contentType' => [ 'shape' => 'MimeType', 'location' => 'header', 'locationName' => 'X-Amzn-Bedrock-Content-Type', ], ], 'payload' => 'body', ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'Message' => [ 'type' => 'structure', 'required' => [ 'role', 'content', ], 'members' => [ 'role' => [ 'shape' => 'ConversationRole', ], 'content' => [ 'shape' => 'ContentBlocks', ], ], ], 'MessageStartEvent' => [ 'type' => 'structure', 'required' => [ 'role', ], 'members' => [ 'role' => [ 'shape' => 'ConversationRole', ], ], 'event' => true, ], 'MessageStopEvent' => [ 'type' => 'structure', 'required' => [ 'stopReason', ], 'members' => [ 'stopReason' => [ 'shape' => 'StopReason', ], 'additionalModelResponseFields' => [ 'shape' => 'Document', ], ], 'event' => true, ], 'Messages' => [ 'type' => 'list', 'member' => [ 'shape' => 'Message', ], ], 'MimeType' => [ 'type' => 'string', ], 'ModelErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'originalStatusCode' => [ 'shape' => 'StatusCode', ], 'resourceName' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'ModelNotReadyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => false, ], ], 'ModelOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'GuardrailOutputText', ], ], 'ModelStreamErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], 'originalStatusCode' => [ 'shape' => 'StatusCode', ], 'originalMessage' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 424, 'senderFault' => true, ], 'exception' => true, ], 'ModelTimeoutException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '[\\s\\S]*', ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], 'NonNegativeInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'PartBody' => [ 'type' => 'blob', 'max' => 1000000, 'min' => 0, 'sensitive' => true, ], 'PayloadPart' => [ 'type' => 'structure', 'members' => [ 'bytes' => [ 'shape' => 'PartBody', ], ], 'event' => true, 'sensitive' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResponseStream' => [ 'type' => 'structure', 'members' => [ 'chunk' => [ 'shape' => 'PayloadPart', ], 'internalServerException' => [ 'shape' => 'InternalServerException', ], 'modelStreamErrorException' => [ 'shape' => 'ModelStreamErrorException', ], 'validationException' => [ 'shape' => 'ValidationException', ], 'throttlingException' => [ 'shape' => 'ThrottlingException', ], 'modelTimeoutException' => [ 'shape' => 'ModelTimeoutException', ], 'serviceUnavailableException' => [ 'shape' => 'ServiceUnavailableException', ], ], 'eventstream' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SpecificToolChoice' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ToolName', ], ], ], 'StatusCode' => [ 'type' => 'integer', 'box' => true, 'max' => 599, 'min' => 100, ], 'StopReason' => [ 'type' => 'string', 'enum' => [ 'end_turn', 'tool_use', 'max_tokens', 'stop_sequence', 'guardrail_intervened', 'content_filtered', ], ], 'String' => [ 'type' => 'string', ], 'SystemContentBlock' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'NonEmptyString', ], 'guardContent' => [ 'shape' => 'GuardrailConverseContentBlock', ], ], 'union' => true, ], 'SystemContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemContentBlock', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, ], 'TokenUsage' => [ 'type' => 'structure', 'required' => [ 'inputTokens', 'outputTokens', 'totalTokens', ], 'members' => [ 'inputTokens' => [ 'shape' => 'TokenUsageInputTokensInteger', ], 'outputTokens' => [ 'shape' => 'TokenUsageOutputTokensInteger', ], 'totalTokens' => [ 'shape' => 'TokenUsageTotalTokensInteger', ], ], ], 'TokenUsageInputTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TokenUsageOutputTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'TokenUsageTotalTokensInteger' => [ 'type' => 'integer', 'box' => true, 'min' => 0, ], 'Tool' => [ 'type' => 'structure', 'members' => [ 'toolSpec' => [ 'shape' => 'ToolSpecification', ], ], 'union' => true, ], 'ToolChoice' => [ 'type' => 'structure', 'members' => [ 'auto' => [ 'shape' => 'AutoToolChoice', ], 'any' => [ 'shape' => 'AnyToolChoice', ], 'tool' => [ 'shape' => 'SpecificToolChoice', ], ], 'union' => true, ], 'ToolConfiguration' => [ 'type' => 'structure', 'required' => [ 'tools', ], 'members' => [ 'tools' => [ 'shape' => 'ToolConfigurationToolsList', ], 'toolChoice' => [ 'shape' => 'ToolChoice', ], ], ], 'ToolConfigurationToolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tool', ], 'min' => 1, ], 'ToolInputSchema' => [ 'type' => 'structure', 'members' => [ 'json' => [ 'shape' => 'Document', ], ], 'union' => true, ], 'ToolName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9_]*', ], 'ToolResultBlock' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'content', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'content' => [ 'shape' => 'ToolResultContentBlocks', ], 'status' => [ 'shape' => 'ToolResultStatus', ], ], ], 'ToolResultContentBlock' => [ 'type' => 'structure', 'members' => [ 'json' => [ 'shape' => 'Document', ], 'text' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'ImageBlock', ], 'document' => [ 'shape' => 'DocumentBlock', ], ], 'union' => true, ], 'ToolResultContentBlocks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ToolResultContentBlock', ], ], 'ToolResultStatus' => [ 'type' => 'string', 'enum' => [ 'success', 'error', ], ], 'ToolSpecification' => [ 'type' => 'structure', 'required' => [ 'name', 'inputSchema', ], 'members' => [ 'name' => [ 'shape' => 'ToolName', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'inputSchema' => [ 'shape' => 'ToolInputSchema', ], ], ], 'ToolUseBlock' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'name', 'input', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'name' => [ 'shape' => 'ToolName', ], 'input' => [ 'shape' => 'Document', ], ], ], 'ToolUseBlockDelta' => [ 'type' => 'structure', 'required' => [ 'input', ], 'members' => [ 'input' => [ 'shape' => 'String', ], ], ], 'ToolUseBlockStart' => [ 'type' => 'structure', 'required' => [ 'toolUseId', 'name', ], 'members' => [ 'toolUseId' => [ 'shape' => 'ToolUseId', ], 'name' => [ 'shape' => 'ToolName', ], ], ], 'ToolUseId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'Trace' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'NonBlankString', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; diff --git a/src/data/bedrock-runtime/2023-09-30/docs-2.json b/src/data/bedrock-runtime/2023-09-30/docs-2.json index 902d547662..38cd006d44 100644 --- a/src/data/bedrock-runtime/2023-09-30/docs-2.json +++ b/src/data/bedrock-runtime/2023-09-30/docs-2.json @@ -96,8 +96,8 @@ "ConversationalModelId": { "base": null, "refs": { - "ConverseRequest$modelId": "

The identifier for the model that you want to call.

The modelId to provide depends on the type of model that you use:

", - "ConverseStreamRequest$modelId": "

The ID for the model.

The modelId to provide depends on the type of model that you use:

" + "ConverseRequest$modelId": "

The identifier for the model that you want to call.

The modelId to provide depends on the type of model or throughput that you use:

The Converse API doesn't support imported models.

", + "ConverseStreamRequest$modelId": "

The ID for the model.

The modelId to provide depends on the type of model or throughput that you use:

The Converse API doesn't support imported models.

" } }, "ConverseMetrics": { @@ -695,8 +695,8 @@ "InvokeModelIdentifier": { "base": null, "refs": { - "InvokeModelRequest$modelId": "

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

", - "InvokeModelWithResponseStreamRequest$modelId": "

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

" + "InvokeModelRequest$modelId": "

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

", + "InvokeModelWithResponseStreamRequest$modelId": "

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

" } }, "InvokeModelRequest": { @@ -769,7 +769,7 @@ } }, "ModelNotReadyException": { - "base": "

The model specified in the request is not ready to serve inference requests.

", + "base": "

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.

", "refs": { } }, diff --git a/src/data/bedrock-runtime/2023-09-30/docs-2.json.php b/src/data/bedrock-runtime/2023-09-30/docs-2.json.php index d84c8ad20b..19ede18971 100644 --- a/src/data/bedrock-runtime/2023-09-30/docs-2.json.php +++ b/src/data/bedrock-runtime/2023-09-30/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Describes the API operations for running inference using Amazon Bedrock models.

', 'operations' => [ 'ApplyGuardrail' => '

The action to apply a guardrail.

', 'Converse' => '

Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn\'t store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

', 'ConverseStream' => '

Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model.

To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including ConverseStream.

Amazon Bedrock doesn\'t store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Conversation streaming example in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModelWithResponseStream action.

', 'InvokeModel' => '

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

', 'InvokeModelWithResponseStream' => '

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

The request is denied because of missing access permissions.

', 'refs' => [], ], 'AnyToolChoice' => [ 'base' => '

The model must request at least one tool (no text is generated). For example, {"any" : {}}.

', 'refs' => [ 'ToolChoice$any' => '

The model must request at least one tool (no text is generated).

', ], ], 'ApplyGuardrailRequest' => [ 'base' => NULL, 'refs' => [], ], 'ApplyGuardrailResponse' => [ 'base' => NULL, 'refs' => [], ], 'AutoToolChoice' => [ 'base' => '

The Model automatically decides if a tool should be called or whether to generate text instead. For example, {"auto" : {}}.

', 'refs' => [ 'ToolChoice$auto' => '

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

', ], ], 'Body' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$body' => '

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

', 'InvokeModelResponse$body' => '

Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.

', 'InvokeModelWithResponseStreamRequest$body' => '

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

', ], ], 'ContentBlock' => [ 'base' => '

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

', 'refs' => [ 'ContentBlocks$member' => NULL, ], ], 'ContentBlockDelta' => [ 'base' => '

A bock of content in a streaming response.

', 'refs' => [ 'ContentBlockDeltaEvent$delta' => '

The delta for a content block delta event.

', ], ], 'ContentBlockDeltaEvent' => [ 'base' => '

The content block delta event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockDelta' => '

The messages output content block delta.

', ], ], 'ContentBlockStart' => [ 'base' => '

Content block start information.

', 'refs' => [ 'ContentBlockStartEvent$start' => '

Start information about a content block start event.

', ], ], 'ContentBlockStartEvent' => [ 'base' => '

Content block start event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockStart' => '

Start information for a content block.

', ], ], 'ContentBlockStopEvent' => [ 'base' => '

A content block stop event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockStop' => '

Stop information for a content block.

', ], ], 'ContentBlocks' => [ 'base' => NULL, 'refs' => [ 'Message$content' => '

The message content. Note the following restrictions:

', ], ], 'ConversationRole' => [ 'base' => NULL, 'refs' => [ 'Message$role' => '

The role that the message plays in the message.

', 'MessageStartEvent$role' => '

The role for the message.

', ], ], 'ConversationalModelId' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$modelId' => '

The identifier for the model that you want to call.

The modelId to provide depends on the type of model that you use:

', 'ConverseStreamRequest$modelId' => '

The ID for the model.

The modelId to provide depends on the type of model that you use:

', ], ], 'ConverseMetrics' => [ 'base' => '

Metrics for a call to Converse.

', 'refs' => [ 'ConverseResponse$metrics' => '

Metrics for the call to Converse.

', ], ], 'ConverseOutput' => [ 'base' => '

The output from a call to Converse.

', 'refs' => [ 'ConverseResponse$output' => '

The result from the call to Converse.

', ], ], 'ConverseRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConverseRequestAdditionalModelResponseFieldPathsList' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$additionalModelResponseFieldPaths' => '

Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

', ], ], 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'base' => NULL, 'refs' => [ 'ConverseRequestAdditionalModelResponseFieldPathsList$member' => NULL, ], ], 'ConverseResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamMetadataEvent' => [ 'base' => '

A conversation stream metadata event.

', 'refs' => [ 'ConverseStreamOutput$metadata' => '

Metadata for the converse output stream.

', ], ], 'ConverseStreamMetrics' => [ 'base' => '

Metrics for the stream.

', 'refs' => [ 'ConverseStreamMetadataEvent$metrics' => '

The metrics for the conversation stream metadata event.

', ], ], 'ConverseStreamOutput' => [ 'base' => '

The messages output stream

', 'refs' => [ 'ConverseStreamResponse$stream' => '

The output stream that the model generated.

', ], ], 'ConverseStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsList' => [ 'base' => NULL, 'refs' => [ 'ConverseStreamRequest$additionalModelResponseFieldPaths' => '

Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.

', ], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'base' => NULL, 'refs' => [ 'ConverseStreamRequestAdditionalModelResponseFieldPathsList$member' => NULL, ], ], 'ConverseStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamTrace' => [ 'base' => '

The trace object in a response from ConverseStream. Currently, you can only trace guardrails.

', 'refs' => [ 'ConverseStreamMetadataEvent$trace' => '

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

', ], ], 'ConverseTrace' => [ 'base' => '

The trace object in a response from Converse. Currently, you can only trace guardrails.

', 'refs' => [ 'ConverseResponse$trace' => '

A trace object that contains information about the Guardrail behavior.

', ], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$additionalModelRequestFields' => '

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.

', 'ConverseResponse$additionalModelResponseFields' => '

Additional fields in the response that are unique to the model.

', 'ConverseStreamRequest$additionalModelRequestFields' => '

Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.

', 'MessageStopEvent$additionalModelResponseFields' => '

The additional model response fields.

', 'ToolInputSchema$json' => '

The JSON schema for the tool. For more information, see JSON Schema Reference.

', 'ToolResultContentBlock$json' => '

A tool result that is JSON format data.

', 'ToolUseBlock$input' => '

The input to pass to the tool.

', ], ], 'DocumentBlock' => [ 'base' => '

A document to include in a message.

', 'refs' => [ 'ContentBlock$document' => '

A document to include in the message.

', 'ToolResultContentBlock$document' => '

A tool result that is a document.

', ], ], 'DocumentBlockNameString' => [ 'base' => NULL, 'refs' => [ 'DocumentBlock$name' => '

A name for the document. The name can only contain the following characters:

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

', ], ], 'DocumentFormat' => [ 'base' => NULL, 'refs' => [ 'DocumentBlock$format' => '

The format of a document, or its extension.

', ], ], 'DocumentSource' => [ 'base' => '

Contains the content of a document.

', 'refs' => [ 'DocumentBlock$source' => '

Contains the content of the document.

', ], ], 'DocumentSourceBytesBlob' => [ 'base' => NULL, 'refs' => [ 'DocumentSource$bytes' => '

The raw bytes for the document. If you use an Amazon Web Services SDK, you don\'t need to encode the bytes in base64.

', ], ], 'GuardrailAction' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$action' => '

The action taken in the response from the guardrail.

', ], ], 'GuardrailAssessment' => [ 'base' => '

A behavior assessment of the guardrail policies used in a call to the Converse API.

', 'refs' => [ 'GuardrailAssessmentList$member' => NULL, 'GuardrailAssessmentMap$value' => NULL, ], ], 'GuardrailAssessmentList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$assessments' => '

The assessment details in the response from the guardrail.

', 'GuardrailAssessmentListMap$value' => NULL, ], ], 'GuardrailAssessmentListMap' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$outputAssessments' => '

the output assessments.

', ], ], 'GuardrailAssessmentMap' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$inputAssessment' => '

The input assessment.

', ], ], 'GuardrailConfiguration' => [ 'base' => '

Configuration information for a guardrail that you use with the Converse operation.

', 'refs' => [ 'ConverseRequest$guardrailConfig' => '

Configuration information for a guardrail that you want to use in the request.

', ], ], 'GuardrailContentBlock' => [ 'base' => '

The content block to be evaluated by the guardrail.

', 'refs' => [ 'GuardrailContentBlockList$member' => NULL, ], ], 'GuardrailContentBlockList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$content' => '

The content details used in the request to apply the guardrail.

', ], ], 'GuardrailContentFilter' => [ 'base' => '

The content filter for a guardrail.

', 'refs' => [ 'GuardrailContentFilterList$member' => NULL, ], ], 'GuardrailContentFilterConfidence' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$confidence' => '

The guardrail confidence.

', ], ], 'GuardrailContentFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentPolicyAssessment$filters' => '

The content policy filters.

', ], ], 'GuardrailContentFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$type' => '

The guardrail type.

', ], ], 'GuardrailContentPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$action' => '

The guardrail action.

', ], ], 'GuardrailContentPolicyAssessment' => [ 'base' => '

An assessment of a content policy for a guardrail.

', 'refs' => [ 'GuardrailAssessment$contentPolicy' => '

The content policy.

', ], ], 'GuardrailContentPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$contentPolicyUnits' => '

The content policy units processed by the guardrail.

', ], ], 'GuardrailContentQualifier' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentQualifierList$member' => NULL, ], ], 'GuardrailContentQualifierList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTextBlock$qualifiers' => '

The qualifiers describing the text block.

', ], ], 'GuardrailContentSource' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$source' => '

The source of data used in the request to apply the guardrail.

', ], ], 'GuardrailContextualGroundingFilter' => [ 'base' => '

The details for the guardrails contextual grounding filter.

', 'refs' => [ 'GuardrailContextualGroundingFilters$member' => NULL, ], ], 'GuardrailContextualGroundingFilterScoreDouble' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$score' => '

The score generated by contextual grounding filter.

', ], ], 'GuardrailContextualGroundingFilterThresholdDouble' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$threshold' => '

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

', ], ], 'GuardrailContextualGroundingFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$type' => '

The contextual grounding filter type.

', ], ], 'GuardrailContextualGroundingFilters' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingPolicyAssessment$filters' => '

The filter details for the guardrails contextual grounding filter.

', ], ], 'GuardrailContextualGroundingPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$action' => '

The action performed by the guardrails contextual grounding filter.

', ], ], 'GuardrailContextualGroundingPolicyAssessment' => [ 'base' => '

The policy assessment details for the guardrails contextual grounding filter.

', 'refs' => [ 'GuardrailAssessment$contextualGroundingPolicy' => '

The contextual grounding policy used for the guardrail assessment.

', ], ], 'GuardrailContextualGroundingPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$contextualGroundingPolicyUnits' => '

The contextual grounding policy units processed by the guardrail.

', ], ], 'GuardrailConverseContentBlock' => [ 'base' => '

A content block for selective guarding with the Converse or ConverseStream API operations.

', 'refs' => [ 'ContentBlock$guardContent' => '

Contains the content to assess with the guardrail. If you don\'t specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. 

 </p>
', 'SystemContentBlock$guardContent' => '

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

', ], ], 'GuardrailConverseContentQualifier' => [ 'base' => NULL, 'refs' => [ 'GuardrailConverseContentQualifierList$member' => NULL, ], ], 'GuardrailConverseContentQualifierList' => [ 'base' => NULL, 'refs' => [ 'GuardrailConverseTextBlock$qualifiers' => '

The qualifier details for the guardrails contextual grounding filter.

', ], ], 'GuardrailConverseTextBlock' => [ 'base' => '

A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.

', 'refs' => [ 'GuardrailConverseContentBlock$text' => '

The text to guard.

', ], ], 'GuardrailCustomWord' => [ 'base' => '

A custom word configured in a guardrail.

', 'refs' => [ 'GuardrailCustomWordList$member' => NULL, ], ], 'GuardrailCustomWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$customWords' => '

Custom words in the assessment.

', ], ], 'GuardrailIdentifier' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$guardrailIdentifier' => '

The guardrail identifier used in the request to apply the guardrail.

', 'GuardrailConfiguration$guardrailIdentifier' => '

The identifier for the guardrail.

', 'GuardrailStreamConfiguration$guardrailIdentifier' => '

The identifier for the guardrail.

', 'InvokeModelRequest$guardrailIdentifier' => '

The unique identifier of the guardrail that you want to use. If you don\'t provide a value, no guardrail is applied to the invocation.

An error will be thrown in the following situations.

', 'InvokeModelWithResponseStreamRequest$guardrailIdentifier' => '

The unique identifier of the guardrail that you want to use. If you don\'t provide a value, no guardrail is applied to the invocation.

An error is thrown in the following situations.

', ], ], 'GuardrailManagedWord' => [ 'base' => '

A managed word configured in a guardrail.

', 'refs' => [ 'GuardrailManagedWordList$member' => NULL, ], ], 'GuardrailManagedWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$managedWordLists' => '

Managed word lists in the assessment.

', ], ], 'GuardrailManagedWordType' => [ 'base' => NULL, 'refs' => [ 'GuardrailManagedWord$type' => '

The type for the managed word.

', ], ], 'GuardrailOutputContent' => [ 'base' => '

The output content produced by the guardrail.

', 'refs' => [ 'GuardrailOutputContentList$member' => NULL, ], ], 'GuardrailOutputContentList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$outputs' => '

The output details in the response from the guardrail.

', ], ], 'GuardrailOutputText' => [ 'base' => NULL, 'refs' => [ 'GuardrailOutputContent$text' => '

The specific text for the output content produced by the guardrail.

', 'ModelOutputs$member' => NULL, ], ], 'GuardrailPiiEntityFilter' => [ 'base' => '

A Personally Identifiable Information (PII) entity configured in a guardrail.

', 'refs' => [ 'GuardrailPiiEntityFilterList$member' => NULL, ], ], 'GuardrailPiiEntityFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$piiEntities' => '

The PII entities in the assessment.

', ], ], 'GuardrailPiiEntityType' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$type' => '

The PII entity filter type.

', ], ], 'GuardrailRegexFilter' => [ 'base' => '

A Regex filter configured in a guardrail.

', 'refs' => [ 'GuardrailRegexFilterList$member' => NULL, ], ], 'GuardrailRegexFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$regexes' => '

The regex queries in the assessment.

', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$action' => '

The PII entity filter action.

', 'GuardrailRegexFilter$action' => '

The region filter action.

', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'base' => '

The assessment for aPersonally Identifiable Information (PII) policy.

', 'refs' => [ 'GuardrailAssessment$sensitiveInformationPolicy' => '

The sensitive information policy.

', ], ], 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$sensitiveInformationPolicyFreeUnits' => '

The sensitive information policy free units processed by the guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$sensitiveInformationPolicyUnits' => '

The sensitive information policy units processed by the guardrail.

', ], ], 'GuardrailStreamConfiguration' => [ 'base' => '

Configuration information for a guardrail that you use with the ConverseStream action.

', 'refs' => [ 'ConverseStreamRequest$guardrailConfig' => '

Configuration information for a guardrail that you want to use in the request.

', ], ], 'GuardrailStreamProcessingMode' => [ 'base' => NULL, 'refs' => [ 'GuardrailStreamConfiguration$streamProcessingMode' => '

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

', ], ], 'GuardrailTextBlock' => [ 'base' => '

The text block to be evaluated by the guardrail.

', 'refs' => [ 'GuardrailContentBlock$text' => '

Text within content block to be evaluated by the guardrail.

', ], ], 'GuardrailTopic' => [ 'base' => '

Information about a topic guardrail.

', 'refs' => [ 'GuardrailTopicList$member' => NULL, ], ], 'GuardrailTopicList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopicPolicyAssessment$topics' => '

The topics in the assessment.

', ], ], 'GuardrailTopicPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$action' => '

The action the guardrail should take when it intervenes on a topic.

', ], ], 'GuardrailTopicPolicyAssessment' => [ 'base' => '

A behavior assessment of a topic policy.

', 'refs' => [ 'GuardrailAssessment$topicPolicy' => '

The topic policy.

', ], ], 'GuardrailTopicPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$topicPolicyUnits' => '

The topic policy units processed by the guardrail.

', ], ], 'GuardrailTopicType' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$type' => '

The type behavior that the guardrail should perform when the model detects the topic.

', ], ], 'GuardrailTrace' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$trace' => '

The trace behavior for the guardrail.

', 'GuardrailStreamConfiguration$trace' => '

The trace behavior for the guardrail.

', ], ], 'GuardrailTraceAssessment' => [ 'base' => '

A Top level guardrail trace object. For more information, see ConverseTrace.

', 'refs' => [ 'ConverseStreamTrace$guardrail' => '

The guardrail trace object.

', 'ConverseTrace$guardrail' => '

The guardrail trace object.

', ], ], 'GuardrailUsage' => [ 'base' => '

The details on the use of the guardrail.

', 'refs' => [ 'ApplyGuardrailResponse$usage' => '

The usage details in the response from the guardrail.

', ], ], 'GuardrailVersion' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$guardrailVersion' => '

The guardrail version used in the request to apply the guardrail.

', 'GuardrailConfiguration$guardrailVersion' => '

The version of the guardrail.

', 'GuardrailStreamConfiguration$guardrailVersion' => '

The version of the guardrail.

', 'InvokeModelRequest$guardrailVersion' => '

The version number for the guardrail. The value can also be DRAFT.

', 'InvokeModelWithResponseStreamRequest$guardrailVersion' => '

The version number for the guardrail. The value can also be DRAFT.

', ], ], 'GuardrailWordPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailCustomWord$action' => '

The action for the custom word.

', 'GuardrailManagedWord$action' => '

The action for the managed word.

', ], ], 'GuardrailWordPolicyAssessment' => [ 'base' => '

The word policy assessment.

', 'refs' => [ 'GuardrailAssessment$wordPolicy' => '

The word policy.

', ], ], 'GuardrailWordPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$wordPolicyUnits' => '

The word policy units processed by the guardrail.

', ], ], 'ImageBlock' => [ 'base' => '

Image content for a message.

', 'refs' => [ 'ContentBlock$image' => '

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

', 'ToolResultContentBlock$image' => '

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

', ], ], 'ImageFormat' => [ 'base' => NULL, 'refs' => [ 'ImageBlock$format' => '

The format of the image.

', ], ], 'ImageSource' => [ 'base' => '

The source for an image.

', 'refs' => [ 'ImageBlock$source' => '

The source for the image.

', ], ], 'ImageSourceBytesBlob' => [ 'base' => NULL, 'refs' => [ 'ImageSource$bytes' => '

The raw image bytes for the image. If you use an AWS SDK, you don\'t need to encode the image bytes in base64.

', ], ], 'InferenceConfiguration' => [ 'base' => '

Base inference parameters to pass to a model in a call to Converse or ConverseStream. For more information, see Inference parameters for foundation models.

If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field in the call to Converse or ConverseStream. For more information, see Model parameters.

', 'refs' => [ 'ConverseRequest$inferenceConfig' => '

Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

', 'ConverseStreamRequest$inferenceConfig' => '

Inference parameters to pass to the model. ConverseStream supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

', ], ], 'InferenceConfigurationMaxTokensInteger' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maxTokens' => '

The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InferenceConfigurationStopSequencesList' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => '

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

', ], ], 'InferenceConfigurationTemperatureFloat' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => '

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InferenceConfigurationTopPFloat' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topP' => '

The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InternalServerException' => [ 'base' => '

An internal server error occurred. Retry your request.

', 'refs' => [ 'ConverseStreamOutput$internalServerException' => '

An internal server error occurred. Retry your request.

', 'ResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', ], ], 'InvokeModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$modelId' => '

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

', 'InvokeModelWithResponseStreamRequest$modelId' => '

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

', ], ], 'InvokeModelRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelResponse' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelWithResponseStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelWithResponseStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ConverseMetrics$latencyMs' => '

The latency of the call to Converse, in milliseconds.

', 'ConverseStreamMetrics$latencyMs' => '

The latency for the streaming request, in milliseconds.

', ], ], 'Message' => [ 'base' => '

A message input, or returned from, a call to Converse or ConverseStream.

', 'refs' => [ 'ConverseOutput$message' => '

The message that the model generates.

', 'Messages$member' => NULL, ], ], 'MessageStartEvent' => [ 'base' => '

The start of a message.

', 'refs' => [ 'ConverseStreamOutput$messageStart' => '

Message start information.

', ], ], 'MessageStopEvent' => [ 'base' => '

The stop event for a message.

', 'refs' => [ 'ConverseStreamOutput$messageStop' => '

Message stop information.

', ], ], 'Messages' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$messages' => '

The messages that you want to send to the model.

', 'ConverseStreamRequest$messages' => '

The messages that you want to send to the model.

', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$contentType' => '

The MIME type of the input data in the request. You must specify application/json.

', 'InvokeModelRequest$accept' => '

The desired MIME type of the inference body in the response. The default value is application/json.

', 'InvokeModelResponse$contentType' => '

The MIME type of the inference result.

', 'InvokeModelWithResponseStreamRequest$contentType' => '

The MIME type of the input data in the request. You must specify application/json.

', 'InvokeModelWithResponseStreamRequest$accept' => '

The desired MIME type of the inference body in the response. The default value is application/json.

', 'InvokeModelWithResponseStreamResponse$contentType' => '

The MIME type of the inference result.

', ], ], 'ModelErrorException' => [ 'base' => '

The request failed due to an error while processing the model.

', 'refs' => [], ], 'ModelNotReadyException' => [ 'base' => '

The model specified in the request is not ready to serve inference requests.

', 'refs' => [], ], 'ModelOutputs' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$modelOutput' => '

The output from the model.

', ], ], 'ModelStreamErrorException' => [ 'base' => '

An error occurred while streaming the response. Retry your request.

', 'refs' => [ 'ConverseStreamOutput$modelStreamErrorException' => '

A streaming error occurred. Retry your request.

', 'ResponseStream$modelStreamErrorException' => '

An error occurred while streaming the response. Retry your request.

', ], ], 'ModelTimeoutException' => [ 'base' => '

The request took too long to process. Processing time exceeded the model timeout length.

', 'refs' => [ 'ResponseStream$modelTimeoutException' => '

The request took too long to process. Processing time exceeded the model timeout length.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'InternalServerException$message' => NULL, 'ModelErrorException$message' => NULL, 'ModelErrorException$resourceName' => '

The resource name.

', 'ModelNotReadyException$message' => NULL, 'ModelStreamErrorException$message' => NULL, 'ModelStreamErrorException$originalMessage' => '

The original message.

', 'ModelTimeoutException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ServiceUnavailableException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'InferenceConfigurationStopSequencesList$member' => NULL, 'SystemContentBlock$text' => '

A system prompt for the model.

', 'ToolSpecification$description' => '

The description for the tool.

', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'ContentBlockDeltaEvent$contentBlockIndex' => '

The block index for a content block delta event.

', 'ContentBlockStartEvent$contentBlockIndex' => '

The index for a content block start event.

', 'ContentBlockStopEvent$contentBlockIndex' => '

The index for a content block.

', ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => '

Base64-encoded bytes of payload data.

', ], ], 'PayloadPart' => [ 'base' => '

Payload content included in the response.

', 'refs' => [ 'ResponseStream$chunk' => '

Content included in the response.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource ARN was not found. Check the ARN and try your request again.

', 'refs' => [], ], 'ResponseStream' => [ 'base' => '

Definition of content in the response stream.

', 'refs' => [ 'InvokeModelWithResponseStreamResponse$body' => '

Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '

The service isn\'t currently available. Try again later.

', 'refs' => [ 'ConverseStreamOutput$serviceUnavailableException' => '

The service isn\'t currently available. Try again later.

', 'ResponseStream$serviceUnavailableException' => NULL, ], ], 'SpecificToolChoice' => [ 'base' => '

The model must request a specific tool. For example, {"tool" : {"name" : "Your tool name"}}.

This field is only supported by Anthropic Claude 3 models.

', 'refs' => [ 'ToolChoice$tool' => '

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'ModelErrorException$originalStatusCode' => '

The original status code.

', 'ModelStreamErrorException$originalStatusCode' => '

The original status code.

', ], ], 'StopReason' => [ 'base' => NULL, 'refs' => [ 'ConverseResponse$stopReason' => '

The reason why the model stopped generating output.

', 'MessageStopEvent$stopReason' => '

The reason why the model stopped generating output.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ContentBlock$text' => '

Text to include in the message.

', 'ContentBlockDelta$text' => '

The content text.

', 'GuardrailAssessmentListMap$key' => NULL, 'GuardrailAssessmentMap$key' => NULL, 'GuardrailConverseTextBlock$text' => '

The text that you want to guard.

', 'GuardrailCustomWord$match' => '

The match for the custom word.

', 'GuardrailManagedWord$match' => '

The match for the managed word.

', 'GuardrailPiiEntityFilter$match' => '

The PII entity filter match.

', 'GuardrailRegexFilter$name' => '

The regex filter name.

', 'GuardrailRegexFilter$match' => '

The regesx filter match.

', 'GuardrailRegexFilter$regex' => '

The regex query.

', 'GuardrailTextBlock$text' => '

The input text details to be evaluated by the guardrail.

', 'GuardrailTopic$name' => '

The name for the guardrail.

', 'ToolResultContentBlock$text' => '

A tool result that is text.

', 'ToolUseBlockDelta$input' => '

The input for a requested tool.

', ], ], 'SystemContentBlock' => [ 'base' => '

A system content block.

', 'refs' => [ 'SystemContentBlocks$member' => NULL, ], ], 'SystemContentBlocks' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$system' => '

A system prompt to pass to the model.

', 'ConverseStreamRequest$system' => '

A system prompt to send to the model.

', ], ], 'ThrottlingException' => [ 'base' => '

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.

', 'refs' => [ 'ConverseStreamOutput$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'ResponseStream$throttlingException' => '

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.

', ], ], 'TokenUsage' => [ 'base' => '

The tokens used in a message API inference call.

', 'refs' => [ 'ConverseResponse$usage' => '

The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

', 'ConverseStreamMetadataEvent$usage' => '

Usage information for the conversation stream event.

', ], ], 'TokenUsageInputTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$inputTokens' => '

The number of tokens sent in the request to the model.

', ], ], 'TokenUsageOutputTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$outputTokens' => '

The number of tokens that the model generated for the request.

', ], ], 'TokenUsageTotalTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$totalTokens' => '

The total of input tokens and tokens generated by the model.

', ], ], 'Tool' => [ 'base' => '

Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

', 'refs' => [ 'ToolConfigurationToolsList$member' => NULL, ], ], 'ToolChoice' => [ 'base' => '

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

', 'refs' => [ 'ToolConfiguration$toolChoice' => '

If supported by model, forces the model to request a tool.

', ], ], 'ToolConfiguration' => [ 'base' => '

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

', 'refs' => [ 'ConverseRequest$toolConfig' => '

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

', 'ConverseStreamRequest$toolConfig' => '

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3 models.

', ], ], 'ToolConfigurationToolsList' => [ 'base' => NULL, 'refs' => [ 'ToolConfiguration$tools' => '

An array of tools that you want to pass to a model.

', ], ], 'ToolInputSchema' => [ 'base' => '

The schema for the tool. The top level schema type must be object.

', 'refs' => [ 'ToolSpecification$inputSchema' => '

The input schema for the tool in JSON format.

', ], ], 'ToolName' => [ 'base' => NULL, 'refs' => [ 'SpecificToolChoice$name' => '

The name of the tool that the model must request.

', 'ToolSpecification$name' => '

The name for the tool.

', 'ToolUseBlock$name' => '

The name of the tool that the model wants to use.

', 'ToolUseBlockStart$name' => '

The name of the tool that the model is requesting to use.

', ], ], 'ToolResultBlock' => [ 'base' => '

A tool result block that contains the results for a tool request that the model previously made.

', 'refs' => [ 'ContentBlock$toolResult' => '

The result for a tool request that a model makes.

', ], ], 'ToolResultContentBlock' => [ 'base' => '

The tool result content block.

', 'refs' => [ 'ToolResultContentBlocks$member' => NULL, ], ], 'ToolResultContentBlocks' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$content' => '

The content for tool result content block.

', ], ], 'ToolResultStatus' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$status' => '

The status for the tool result content block.

This field is only supported Anthropic Claude 3 models.

', ], ], 'ToolSpecification' => [ 'base' => '

The specification for the tool.

', 'refs' => [ 'Tool$toolSpec' => '

The specfication for the tool.

', ], ], 'ToolUseBlock' => [ 'base' => '

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response.

', 'refs' => [ 'ContentBlock$toolUse' => '

Information about a tool use request from a model.

', ], ], 'ToolUseBlockDelta' => [ 'base' => '

The delta for a tool use block.

', 'refs' => [ 'ContentBlockDelta$toolUse' => '

Information about a tool that the model is requesting to use.

', ], ], 'ToolUseBlockStart' => [ 'base' => '

The start of a tool use block.

', 'refs' => [ 'ContentBlockStart$toolUse' => '

Information about a tool that the model is requesting to use.

', ], ], 'ToolUseId' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$toolUseId' => '

The ID of the tool request that this is the result for.

', 'ToolUseBlock$toolUseId' => '

The ID for the tool request.

', 'ToolUseBlockStart$toolUseId' => '

The ID for the tool request.

', ], ], 'Trace' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$trace' => '

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

', 'InvokeModelWithResponseStreamRequest$trace' => '

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

', ], ], 'ValidationException' => [ 'base' => '

Input validation failed. Check your request parameters and retry the request.

', 'refs' => [ 'ConverseStreamOutput$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', 'ResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

Describes the API operations for running inference using Amazon Bedrock models.

', 'operations' => [ 'ApplyGuardrail' => '

The action to apply a guardrail.

', 'Converse' => '

Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn\'t store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

', 'ConverseStream' => '

Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model.

To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including ConverseStream.

Amazon Bedrock doesn\'t store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Conversation streaming example in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModelWithResponseStream action.

', 'InvokeModel' => '

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

', 'InvokeModelWithResponseStream' => '

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn\'t support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

The request is denied because of missing access permissions.

', 'refs' => [], ], 'AnyToolChoice' => [ 'base' => '

The model must request at least one tool (no text is generated). For example, {"any" : {}}.

', 'refs' => [ 'ToolChoice$any' => '

The model must request at least one tool (no text is generated).

', ], ], 'ApplyGuardrailRequest' => [ 'base' => NULL, 'refs' => [], ], 'ApplyGuardrailResponse' => [ 'base' => NULL, 'refs' => [], ], 'AutoToolChoice' => [ 'base' => '

The Model automatically decides if a tool should be called or whether to generate text instead. For example, {"auto" : {}}.

', 'refs' => [ 'ToolChoice$auto' => '

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

', ], ], 'Body' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$body' => '

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

', 'InvokeModelResponse$body' => '

Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.

', 'InvokeModelWithResponseStreamRequest$body' => '

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

', ], ], 'ContentBlock' => [ 'base' => '

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

', 'refs' => [ 'ContentBlocks$member' => NULL, ], ], 'ContentBlockDelta' => [ 'base' => '

A bock of content in a streaming response.

', 'refs' => [ 'ContentBlockDeltaEvent$delta' => '

The delta for a content block delta event.

', ], ], 'ContentBlockDeltaEvent' => [ 'base' => '

The content block delta event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockDelta' => '

The messages output content block delta.

', ], ], 'ContentBlockStart' => [ 'base' => '

Content block start information.

', 'refs' => [ 'ContentBlockStartEvent$start' => '

Start information about a content block start event.

', ], ], 'ContentBlockStartEvent' => [ 'base' => '

Content block start event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockStart' => '

Start information for a content block.

', ], ], 'ContentBlockStopEvent' => [ 'base' => '

A content block stop event.

', 'refs' => [ 'ConverseStreamOutput$contentBlockStop' => '

Stop information for a content block.

', ], ], 'ContentBlocks' => [ 'base' => NULL, 'refs' => [ 'Message$content' => '

The message content. Note the following restrictions:

', ], ], 'ConversationRole' => [ 'base' => NULL, 'refs' => [ 'Message$role' => '

The role that the message plays in the message.

', 'MessageStartEvent$role' => '

The role for the message.

', ], ], 'ConversationalModelId' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$modelId' => '

The identifier for the model that you want to call.

The modelId to provide depends on the type of model or throughput that you use:

The Converse API doesn\'t support imported models.

', 'ConverseStreamRequest$modelId' => '

The ID for the model.

The modelId to provide depends on the type of model or throughput that you use:

The Converse API doesn\'t support imported models.

', ], ], 'ConverseMetrics' => [ 'base' => '

Metrics for a call to Converse.

', 'refs' => [ 'ConverseResponse$metrics' => '

Metrics for the call to Converse.

', ], ], 'ConverseOutput' => [ 'base' => '

The output from a call to Converse.

', 'refs' => [ 'ConverseResponse$output' => '

The result from the call to Converse.

', ], ], 'ConverseRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConverseRequestAdditionalModelResponseFieldPathsList' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$additionalModelResponseFieldPaths' => '

Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

', ], ], 'ConverseRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'base' => NULL, 'refs' => [ 'ConverseRequestAdditionalModelResponseFieldPathsList$member' => NULL, ], ], 'ConverseResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamMetadataEvent' => [ 'base' => '

A conversation stream metadata event.

', 'refs' => [ 'ConverseStreamOutput$metadata' => '

Metadata for the converse output stream.

', ], ], 'ConverseStreamMetrics' => [ 'base' => '

Metrics for the stream.

', 'refs' => [ 'ConverseStreamMetadataEvent$metrics' => '

The metrics for the conversation stream metadata event.

', ], ], 'ConverseStreamOutput' => [ 'base' => '

The messages output stream

', 'refs' => [ 'ConverseStreamResponse$stream' => '

The output stream that the model generated.

', ], ], 'ConverseStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsList' => [ 'base' => NULL, 'refs' => [ 'ConverseStreamRequest$additionalModelResponseFieldPaths' => '

Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.

', ], ], 'ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString' => [ 'base' => NULL, 'refs' => [ 'ConverseStreamRequestAdditionalModelResponseFieldPathsList$member' => NULL, ], ], 'ConverseStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConverseStreamTrace' => [ 'base' => '

The trace object in a response from ConverseStream. Currently, you can only trace guardrails.

', 'refs' => [ 'ConverseStreamMetadataEvent$trace' => '

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

', ], ], 'ConverseTrace' => [ 'base' => '

The trace object in a response from Converse. Currently, you can only trace guardrails.

', 'refs' => [ 'ConverseResponse$trace' => '

A trace object that contains information about the Guardrail behavior.

', ], ], 'Document' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$additionalModelRequestFields' => '

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.

', 'ConverseResponse$additionalModelResponseFields' => '

Additional fields in the response that are unique to the model.

', 'ConverseStreamRequest$additionalModelRequestFields' => '

Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.

', 'MessageStopEvent$additionalModelResponseFields' => '

The additional model response fields.

', 'ToolInputSchema$json' => '

The JSON schema for the tool. For more information, see JSON Schema Reference.

', 'ToolResultContentBlock$json' => '

A tool result that is JSON format data.

', 'ToolUseBlock$input' => '

The input to pass to the tool.

', ], ], 'DocumentBlock' => [ 'base' => '

A document to include in a message.

', 'refs' => [ 'ContentBlock$document' => '

A document to include in the message.

', 'ToolResultContentBlock$document' => '

A tool result that is a document.

', ], ], 'DocumentBlockNameString' => [ 'base' => NULL, 'refs' => [ 'DocumentBlock$name' => '

A name for the document. The name can only contain the following characters:

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

', ], ], 'DocumentFormat' => [ 'base' => NULL, 'refs' => [ 'DocumentBlock$format' => '

The format of a document, or its extension.

', ], ], 'DocumentSource' => [ 'base' => '

Contains the content of a document.

', 'refs' => [ 'DocumentBlock$source' => '

Contains the content of the document.

', ], ], 'DocumentSourceBytesBlob' => [ 'base' => NULL, 'refs' => [ 'DocumentSource$bytes' => '

The raw bytes for the document. If you use an Amazon Web Services SDK, you don\'t need to encode the bytes in base64.

', ], ], 'GuardrailAction' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$action' => '

The action taken in the response from the guardrail.

', ], ], 'GuardrailAssessment' => [ 'base' => '

A behavior assessment of the guardrail policies used in a call to the Converse API.

', 'refs' => [ 'GuardrailAssessmentList$member' => NULL, 'GuardrailAssessmentMap$value' => NULL, ], ], 'GuardrailAssessmentList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$assessments' => '

The assessment details in the response from the guardrail.

', 'GuardrailAssessmentListMap$value' => NULL, ], ], 'GuardrailAssessmentListMap' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$outputAssessments' => '

the output assessments.

', ], ], 'GuardrailAssessmentMap' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$inputAssessment' => '

The input assessment.

', ], ], 'GuardrailConfiguration' => [ 'base' => '

Configuration information for a guardrail that you use with the Converse operation.

', 'refs' => [ 'ConverseRequest$guardrailConfig' => '

Configuration information for a guardrail that you want to use in the request.

', ], ], 'GuardrailContentBlock' => [ 'base' => '

The content block to be evaluated by the guardrail.

', 'refs' => [ 'GuardrailContentBlockList$member' => NULL, ], ], 'GuardrailContentBlockList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$content' => '

The content details used in the request to apply the guardrail.

', ], ], 'GuardrailContentFilter' => [ 'base' => '

The content filter for a guardrail.

', 'refs' => [ 'GuardrailContentFilterList$member' => NULL, ], ], 'GuardrailContentFilterConfidence' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$confidence' => '

The guardrail confidence.

', ], ], 'GuardrailContentFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentPolicyAssessment$filters' => '

The content policy filters.

', ], ], 'GuardrailContentFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$type' => '

The guardrail type.

', ], ], 'GuardrailContentPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentFilter$action' => '

The guardrail action.

', ], ], 'GuardrailContentPolicyAssessment' => [ 'base' => '

An assessment of a content policy for a guardrail.

', 'refs' => [ 'GuardrailAssessment$contentPolicy' => '

The content policy.

', ], ], 'GuardrailContentPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$contentPolicyUnits' => '

The content policy units processed by the guardrail.

', ], ], 'GuardrailContentQualifier' => [ 'base' => NULL, 'refs' => [ 'GuardrailContentQualifierList$member' => NULL, ], ], 'GuardrailContentQualifierList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTextBlock$qualifiers' => '

The qualifiers describing the text block.

', ], ], 'GuardrailContentSource' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$source' => '

The source of data used in the request to apply the guardrail.

', ], ], 'GuardrailContextualGroundingFilter' => [ 'base' => '

The details for the guardrails contextual grounding filter.

', 'refs' => [ 'GuardrailContextualGroundingFilters$member' => NULL, ], ], 'GuardrailContextualGroundingFilterScoreDouble' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$score' => '

The score generated by contextual grounding filter.

', ], ], 'GuardrailContextualGroundingFilterThresholdDouble' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$threshold' => '

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

', ], ], 'GuardrailContextualGroundingFilterType' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$type' => '

The contextual grounding filter type.

', ], ], 'GuardrailContextualGroundingFilters' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingPolicyAssessment$filters' => '

The filter details for the guardrails contextual grounding filter.

', ], ], 'GuardrailContextualGroundingPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailContextualGroundingFilter$action' => '

The action performed by the guardrails contextual grounding filter.

', ], ], 'GuardrailContextualGroundingPolicyAssessment' => [ 'base' => '

The policy assessment details for the guardrails contextual grounding filter.

', 'refs' => [ 'GuardrailAssessment$contextualGroundingPolicy' => '

The contextual grounding policy used for the guardrail assessment.

', ], ], 'GuardrailContextualGroundingPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$contextualGroundingPolicyUnits' => '

The contextual grounding policy units processed by the guardrail.

', ], ], 'GuardrailConverseContentBlock' => [ 'base' => '

A content block for selective guarding with the Converse or ConverseStream API operations.

', 'refs' => [ 'ContentBlock$guardContent' => '

Contains the content to assess with the guardrail. If you don\'t specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. 

 </p>
', 'SystemContentBlock$guardContent' => '

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

', ], ], 'GuardrailConverseContentQualifier' => [ 'base' => NULL, 'refs' => [ 'GuardrailConverseContentQualifierList$member' => NULL, ], ], 'GuardrailConverseContentQualifierList' => [ 'base' => NULL, 'refs' => [ 'GuardrailConverseTextBlock$qualifiers' => '

The qualifier details for the guardrails contextual grounding filter.

', ], ], 'GuardrailConverseTextBlock' => [ 'base' => '

A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.

', 'refs' => [ 'GuardrailConverseContentBlock$text' => '

The text to guard.

', ], ], 'GuardrailCustomWord' => [ 'base' => '

A custom word configured in a guardrail.

', 'refs' => [ 'GuardrailCustomWordList$member' => NULL, ], ], 'GuardrailCustomWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$customWords' => '

Custom words in the assessment.

', ], ], 'GuardrailIdentifier' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$guardrailIdentifier' => '

The guardrail identifier used in the request to apply the guardrail.

', 'GuardrailConfiguration$guardrailIdentifier' => '

The identifier for the guardrail.

', 'GuardrailStreamConfiguration$guardrailIdentifier' => '

The identifier for the guardrail.

', 'InvokeModelRequest$guardrailIdentifier' => '

The unique identifier of the guardrail that you want to use. If you don\'t provide a value, no guardrail is applied to the invocation.

An error will be thrown in the following situations.

', 'InvokeModelWithResponseStreamRequest$guardrailIdentifier' => '

The unique identifier of the guardrail that you want to use. If you don\'t provide a value, no guardrail is applied to the invocation.

An error is thrown in the following situations.

', ], ], 'GuardrailManagedWord' => [ 'base' => '

A managed word configured in a guardrail.

', 'refs' => [ 'GuardrailManagedWordList$member' => NULL, ], ], 'GuardrailManagedWordList' => [ 'base' => NULL, 'refs' => [ 'GuardrailWordPolicyAssessment$managedWordLists' => '

Managed word lists in the assessment.

', ], ], 'GuardrailManagedWordType' => [ 'base' => NULL, 'refs' => [ 'GuardrailManagedWord$type' => '

The type for the managed word.

', ], ], 'GuardrailOutputContent' => [ 'base' => '

The output content produced by the guardrail.

', 'refs' => [ 'GuardrailOutputContentList$member' => NULL, ], ], 'GuardrailOutputContentList' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailResponse$outputs' => '

The output details in the response from the guardrail.

', ], ], 'GuardrailOutputText' => [ 'base' => NULL, 'refs' => [ 'GuardrailOutputContent$text' => '

The specific text for the output content produced by the guardrail.

', 'ModelOutputs$member' => NULL, ], ], 'GuardrailPiiEntityFilter' => [ 'base' => '

A Personally Identifiable Information (PII) entity configured in a guardrail.

', 'refs' => [ 'GuardrailPiiEntityFilterList$member' => NULL, ], ], 'GuardrailPiiEntityFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$piiEntities' => '

The PII entities in the assessment.

', ], ], 'GuardrailPiiEntityType' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$type' => '

The PII entity filter type.

', ], ], 'GuardrailRegexFilter' => [ 'base' => '

A Regex filter configured in a guardrail.

', 'refs' => [ 'GuardrailRegexFilterList$member' => NULL, ], ], 'GuardrailRegexFilterList' => [ 'base' => NULL, 'refs' => [ 'GuardrailSensitiveInformationPolicyAssessment$regexes' => '

The regex queries in the assessment.

', ], ], 'GuardrailSensitiveInformationPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailPiiEntityFilter$action' => '

The PII entity filter action.

', 'GuardrailRegexFilter$action' => '

The region filter action.

', ], ], 'GuardrailSensitiveInformationPolicyAssessment' => [ 'base' => '

The assessment for aPersonally Identifiable Information (PII) policy.

', 'refs' => [ 'GuardrailAssessment$sensitiveInformationPolicy' => '

The sensitive information policy.

', ], ], 'GuardrailSensitiveInformationPolicyFreeUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$sensitiveInformationPolicyFreeUnits' => '

The sensitive information policy free units processed by the guardrail.

', ], ], 'GuardrailSensitiveInformationPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$sensitiveInformationPolicyUnits' => '

The sensitive information policy units processed by the guardrail.

', ], ], 'GuardrailStreamConfiguration' => [ 'base' => '

Configuration information for a guardrail that you use with the ConverseStream action.

', 'refs' => [ 'ConverseStreamRequest$guardrailConfig' => '

Configuration information for a guardrail that you want to use in the request.

', ], ], 'GuardrailStreamProcessingMode' => [ 'base' => NULL, 'refs' => [ 'GuardrailStreamConfiguration$streamProcessingMode' => '

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

', ], ], 'GuardrailTextBlock' => [ 'base' => '

The text block to be evaluated by the guardrail.

', 'refs' => [ 'GuardrailContentBlock$text' => '

Text within content block to be evaluated by the guardrail.

', ], ], 'GuardrailTopic' => [ 'base' => '

Information about a topic guardrail.

', 'refs' => [ 'GuardrailTopicList$member' => NULL, ], ], 'GuardrailTopicList' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopicPolicyAssessment$topics' => '

The topics in the assessment.

', ], ], 'GuardrailTopicPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$action' => '

The action the guardrail should take when it intervenes on a topic.

', ], ], 'GuardrailTopicPolicyAssessment' => [ 'base' => '

A behavior assessment of a topic policy.

', 'refs' => [ 'GuardrailAssessment$topicPolicy' => '

The topic policy.

', ], ], 'GuardrailTopicPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$topicPolicyUnits' => '

The topic policy units processed by the guardrail.

', ], ], 'GuardrailTopicType' => [ 'base' => NULL, 'refs' => [ 'GuardrailTopic$type' => '

The type behavior that the guardrail should perform when the model detects the topic.

', ], ], 'GuardrailTrace' => [ 'base' => NULL, 'refs' => [ 'GuardrailConfiguration$trace' => '

The trace behavior for the guardrail.

', 'GuardrailStreamConfiguration$trace' => '

The trace behavior for the guardrail.

', ], ], 'GuardrailTraceAssessment' => [ 'base' => '

A Top level guardrail trace object. For more information, see ConverseTrace.

', 'refs' => [ 'ConverseStreamTrace$guardrail' => '

The guardrail trace object.

', 'ConverseTrace$guardrail' => '

The guardrail trace object.

', ], ], 'GuardrailUsage' => [ 'base' => '

The details on the use of the guardrail.

', 'refs' => [ 'ApplyGuardrailResponse$usage' => '

The usage details in the response from the guardrail.

', ], ], 'GuardrailVersion' => [ 'base' => NULL, 'refs' => [ 'ApplyGuardrailRequest$guardrailVersion' => '

The guardrail version used in the request to apply the guardrail.

', 'GuardrailConfiguration$guardrailVersion' => '

The version of the guardrail.

', 'GuardrailStreamConfiguration$guardrailVersion' => '

The version of the guardrail.

', 'InvokeModelRequest$guardrailVersion' => '

The version number for the guardrail. The value can also be DRAFT.

', 'InvokeModelWithResponseStreamRequest$guardrailVersion' => '

The version number for the guardrail. The value can also be DRAFT.

', ], ], 'GuardrailWordPolicyAction' => [ 'base' => NULL, 'refs' => [ 'GuardrailCustomWord$action' => '

The action for the custom word.

', 'GuardrailManagedWord$action' => '

The action for the managed word.

', ], ], 'GuardrailWordPolicyAssessment' => [ 'base' => '

The word policy assessment.

', 'refs' => [ 'GuardrailAssessment$wordPolicy' => '

The word policy.

', ], ], 'GuardrailWordPolicyUnitsProcessed' => [ 'base' => NULL, 'refs' => [ 'GuardrailUsage$wordPolicyUnits' => '

The word policy units processed by the guardrail.

', ], ], 'ImageBlock' => [ 'base' => '

Image content for a message.

', 'refs' => [ 'ContentBlock$image' => '

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

', 'ToolResultContentBlock$image' => '

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

', ], ], 'ImageFormat' => [ 'base' => NULL, 'refs' => [ 'ImageBlock$format' => '

The format of the image.

', ], ], 'ImageSource' => [ 'base' => '

The source for an image.

', 'refs' => [ 'ImageBlock$source' => '

The source for the image.

', ], ], 'ImageSourceBytesBlob' => [ 'base' => NULL, 'refs' => [ 'ImageSource$bytes' => '

The raw image bytes for the image. If you use an AWS SDK, you don\'t need to encode the image bytes in base64.

', ], ], 'InferenceConfiguration' => [ 'base' => '

Base inference parameters to pass to a model in a call to Converse or ConverseStream. For more information, see Inference parameters for foundation models.

If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field in the call to Converse or ConverseStream. For more information, see Model parameters.

', 'refs' => [ 'ConverseRequest$inferenceConfig' => '

Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

', 'ConverseStreamRequest$inferenceConfig' => '

Inference parameters to pass to the model. ConverseStream supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

', ], ], 'InferenceConfigurationMaxTokensInteger' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$maxTokens' => '

The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InferenceConfigurationStopSequencesList' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$stopSequences' => '

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

', ], ], 'InferenceConfigurationTemperatureFloat' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$temperature' => '

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InferenceConfigurationTopPFloat' => [ 'base' => NULL, 'refs' => [ 'InferenceConfiguration$topP' => '

The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

', ], ], 'InternalServerException' => [ 'base' => '

An internal server error occurred. Retry your request.

', 'refs' => [ 'ConverseStreamOutput$internalServerException' => '

An internal server error occurred. Retry your request.

', 'ResponseStream$internalServerException' => '

An internal server error occurred. Retry your request.

', ], ], 'InvokeModelIdentifier' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$modelId' => '

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

', 'InvokeModelWithResponseStreamRequest$modelId' => '

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

', ], ], 'InvokeModelRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelResponse' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelWithResponseStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeModelWithResponseStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ConverseMetrics$latencyMs' => '

The latency of the call to Converse, in milliseconds.

', 'ConverseStreamMetrics$latencyMs' => '

The latency for the streaming request, in milliseconds.

', ], ], 'Message' => [ 'base' => '

A message input, or returned from, a call to Converse or ConverseStream.

', 'refs' => [ 'ConverseOutput$message' => '

The message that the model generates.

', 'Messages$member' => NULL, ], ], 'MessageStartEvent' => [ 'base' => '

The start of a message.

', 'refs' => [ 'ConverseStreamOutput$messageStart' => '

Message start information.

', ], ], 'MessageStopEvent' => [ 'base' => '

The stop event for a message.

', 'refs' => [ 'ConverseStreamOutput$messageStop' => '

Message stop information.

', ], ], 'Messages' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$messages' => '

The messages that you want to send to the model.

', 'ConverseStreamRequest$messages' => '

The messages that you want to send to the model.

', ], ], 'MimeType' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$contentType' => '

The MIME type of the input data in the request. You must specify application/json.

', 'InvokeModelRequest$accept' => '

The desired MIME type of the inference body in the response. The default value is application/json.

', 'InvokeModelResponse$contentType' => '

The MIME type of the inference result.

', 'InvokeModelWithResponseStreamRequest$contentType' => '

The MIME type of the input data in the request. You must specify application/json.

', 'InvokeModelWithResponseStreamRequest$accept' => '

The desired MIME type of the inference body in the response. The default value is application/json.

', 'InvokeModelWithResponseStreamResponse$contentType' => '

The MIME type of the inference result.

', ], ], 'ModelErrorException' => [ 'base' => '

The request failed due to an error while processing the model.

', 'refs' => [], ], 'ModelNotReadyException' => [ 'base' => '

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.

', 'refs' => [], ], 'ModelOutputs' => [ 'base' => NULL, 'refs' => [ 'GuardrailTraceAssessment$modelOutput' => '

The output from the model.

', ], ], 'ModelStreamErrorException' => [ 'base' => '

An error occurred while streaming the response. Retry your request.

', 'refs' => [ 'ConverseStreamOutput$modelStreamErrorException' => '

A streaming error occurred. Retry your request.

', 'ResponseStream$modelStreamErrorException' => '

An error occurred while streaming the response. Retry your request.

', ], ], 'ModelTimeoutException' => [ 'base' => '

The request took too long to process. Processing time exceeded the model timeout length.

', 'refs' => [ 'ResponseStream$modelTimeoutException' => '

The request took too long to process. Processing time exceeded the model timeout length.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'InternalServerException$message' => NULL, 'ModelErrorException$message' => NULL, 'ModelErrorException$resourceName' => '

The resource name.

', 'ModelNotReadyException$message' => NULL, 'ModelStreamErrorException$message' => NULL, 'ModelStreamErrorException$originalMessage' => '

The original message.

', 'ModelTimeoutException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ServiceUnavailableException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'InferenceConfigurationStopSequencesList$member' => NULL, 'SystemContentBlock$text' => '

A system prompt for the model.

', 'ToolSpecification$description' => '

The description for the tool.

', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'ContentBlockDeltaEvent$contentBlockIndex' => '

The block index for a content block delta event.

', 'ContentBlockStartEvent$contentBlockIndex' => '

The index for a content block start event.

', 'ContentBlockStopEvent$contentBlockIndex' => '

The index for a content block.

', ], ], 'PartBody' => [ 'base' => NULL, 'refs' => [ 'PayloadPart$bytes' => '

Base64-encoded bytes of payload data.

', ], ], 'PayloadPart' => [ 'base' => '

Payload content included in the response.

', 'refs' => [ 'ResponseStream$chunk' => '

Content included in the response.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource ARN was not found. Check the ARN and try your request again.

', 'refs' => [], ], 'ResponseStream' => [ 'base' => '

Definition of content in the response stream.

', 'refs' => [ 'InvokeModelWithResponseStreamResponse$body' => '

Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

', 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '

The service isn\'t currently available. Try again later.

', 'refs' => [ 'ConverseStreamOutput$serviceUnavailableException' => '

The service isn\'t currently available. Try again later.

', 'ResponseStream$serviceUnavailableException' => NULL, ], ], 'SpecificToolChoice' => [ 'base' => '

The model must request a specific tool. For example, {"tool" : {"name" : "Your tool name"}}.

This field is only supported by Anthropic Claude 3 models.

', 'refs' => [ 'ToolChoice$tool' => '

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'ModelErrorException$originalStatusCode' => '

The original status code.

', 'ModelStreamErrorException$originalStatusCode' => '

The original status code.

', ], ], 'StopReason' => [ 'base' => NULL, 'refs' => [ 'ConverseResponse$stopReason' => '

The reason why the model stopped generating output.

', 'MessageStopEvent$stopReason' => '

The reason why the model stopped generating output.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ContentBlock$text' => '

Text to include in the message.

', 'ContentBlockDelta$text' => '

The content text.

', 'GuardrailAssessmentListMap$key' => NULL, 'GuardrailAssessmentMap$key' => NULL, 'GuardrailConverseTextBlock$text' => '

The text that you want to guard.

', 'GuardrailCustomWord$match' => '

The match for the custom word.

', 'GuardrailManagedWord$match' => '

The match for the managed word.

', 'GuardrailPiiEntityFilter$match' => '

The PII entity filter match.

', 'GuardrailRegexFilter$name' => '

The regex filter name.

', 'GuardrailRegexFilter$match' => '

The regesx filter match.

', 'GuardrailRegexFilter$regex' => '

The regex query.

', 'GuardrailTextBlock$text' => '

The input text details to be evaluated by the guardrail.

', 'GuardrailTopic$name' => '

The name for the guardrail.

', 'ToolResultContentBlock$text' => '

A tool result that is text.

', 'ToolUseBlockDelta$input' => '

The input for a requested tool.

', ], ], 'SystemContentBlock' => [ 'base' => '

A system content block.

', 'refs' => [ 'SystemContentBlocks$member' => NULL, ], ], 'SystemContentBlocks' => [ 'base' => NULL, 'refs' => [ 'ConverseRequest$system' => '

A system prompt to pass to the model.

', 'ConverseStreamRequest$system' => '

A system prompt to send to the model.

', ], ], 'ThrottlingException' => [ 'base' => '

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.

', 'refs' => [ 'ConverseStreamOutput$throttlingException' => '

The number of requests exceeds the limit. Resubmit your request later.

', 'ResponseStream$throttlingException' => '

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.

', ], ], 'TokenUsage' => [ 'base' => '

The tokens used in a message API inference call.

', 'refs' => [ 'ConverseResponse$usage' => '

The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

', 'ConverseStreamMetadataEvent$usage' => '

Usage information for the conversation stream event.

', ], ], 'TokenUsageInputTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$inputTokens' => '

The number of tokens sent in the request to the model.

', ], ], 'TokenUsageOutputTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$outputTokens' => '

The number of tokens that the model generated for the request.

', ], ], 'TokenUsageTotalTokensInteger' => [ 'base' => NULL, 'refs' => [ 'TokenUsage$totalTokens' => '

The total of input tokens and tokens generated by the model.

', ], ], 'Tool' => [ 'base' => '

Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

', 'refs' => [ 'ToolConfigurationToolsList$member' => NULL, ], ], 'ToolChoice' => [ 'base' => '

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

', 'refs' => [ 'ToolConfiguration$toolChoice' => '

If supported by model, forces the model to request a tool.

', ], ], 'ToolConfiguration' => [ 'base' => '

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

', 'refs' => [ 'ConverseRequest$toolConfig' => '

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

', 'ConverseStreamRequest$toolConfig' => '

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3 models.

', ], ], 'ToolConfigurationToolsList' => [ 'base' => NULL, 'refs' => [ 'ToolConfiguration$tools' => '

An array of tools that you want to pass to a model.

', ], ], 'ToolInputSchema' => [ 'base' => '

The schema for the tool. The top level schema type must be object.

', 'refs' => [ 'ToolSpecification$inputSchema' => '

The input schema for the tool in JSON format.

', ], ], 'ToolName' => [ 'base' => NULL, 'refs' => [ 'SpecificToolChoice$name' => '

The name of the tool that the model must request.

', 'ToolSpecification$name' => '

The name for the tool.

', 'ToolUseBlock$name' => '

The name of the tool that the model wants to use.

', 'ToolUseBlockStart$name' => '

The name of the tool that the model is requesting to use.

', ], ], 'ToolResultBlock' => [ 'base' => '

A tool result block that contains the results for a tool request that the model previously made.

', 'refs' => [ 'ContentBlock$toolResult' => '

The result for a tool request that a model makes.

', ], ], 'ToolResultContentBlock' => [ 'base' => '

The tool result content block.

', 'refs' => [ 'ToolResultContentBlocks$member' => NULL, ], ], 'ToolResultContentBlocks' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$content' => '

The content for tool result content block.

', ], ], 'ToolResultStatus' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$status' => '

The status for the tool result content block.

This field is only supported Anthropic Claude 3 models.

', ], ], 'ToolSpecification' => [ 'base' => '

The specification for the tool.

', 'refs' => [ 'Tool$toolSpec' => '

The specfication for the tool.

', ], ], 'ToolUseBlock' => [ 'base' => '

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response.

', 'refs' => [ 'ContentBlock$toolUse' => '

Information about a tool use request from a model.

', ], ], 'ToolUseBlockDelta' => [ 'base' => '

The delta for a tool use block.

', 'refs' => [ 'ContentBlockDelta$toolUse' => '

Information about a tool that the model is requesting to use.

', ], ], 'ToolUseBlockStart' => [ 'base' => '

The start of a tool use block.

', 'refs' => [ 'ContentBlockStart$toolUse' => '

Information about a tool that the model is requesting to use.

', ], ], 'ToolUseId' => [ 'base' => NULL, 'refs' => [ 'ToolResultBlock$toolUseId' => '

The ID of the tool request that this is the result for.

', 'ToolUseBlock$toolUseId' => '

The ID for the tool request.

', 'ToolUseBlockStart$toolUseId' => '

The ID for the tool request.

', ], ], 'Trace' => [ 'base' => NULL, 'refs' => [ 'InvokeModelRequest$trace' => '

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

', 'InvokeModelWithResponseStreamRequest$trace' => '

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

', ], ], 'ValidationException' => [ 'base' => '

Input validation failed. Check your request parameters and retry the request.

', 'refs' => [ 'ConverseStreamOutput$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', 'ResponseStream$validationException' => '

Input validation failed. Check your request parameters and retry the request.

', ], ], ],]; diff --git a/src/data/personalize/2018-05-22/api-2.json b/src/data/personalize/2018-05-22/api-2.json index 330edb9f1c..25ea5adfc6 100644 --- a/src/data/personalize/2018-05-22/api-2.json +++ b/src/data/personalize/2018-05-22/api-2.json @@ -11,7 +11,8 @@ "signatureVersion":"v4", "signingName":"personalize", "targetPrefix":"AmazonPersonalize", - "uid":"personalize-2018-05-22" + "uid":"personalize-2018-05-22", + "auth":["aws.auth#sigv4"] }, "operations":{ "CreateBatchInferenceJob":{ @@ -1043,6 +1044,22 @@ {"shape":"ResourceInUseException"} ], "idempotent":true + }, + "UpdateSolution":{ + "name":"UpdateSolution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSolutionRequest"}, + "output":{"shape":"UpdateSolutionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ] } }, "shapes":{ @@ -3003,7 +3020,8 @@ "status":{"shape":"Status"}, "creationDateTime":{"shape":"Date"}, "lastUpdatedDateTime":{"shape":"Date"}, - "latestSolutionVersion":{"shape":"SolutionVersionSummary"} + "latestSolutionVersion":{"shape":"SolutionVersionSummary"}, + "latestSolutionUpdate":{"shape":"SolutionUpdateSummary"} } }, "SolutionConfig":{ @@ -3030,6 +3048,23 @@ "recipeArn":{"shape":"Arn"} } }, + "SolutionUpdateConfig":{ + "type":"structure", + "members":{ + "autoTrainingConfig":{"shape":"AutoTrainingConfig"} + } + }, + "SolutionUpdateSummary":{ + "type":"structure", + "members":{ + "solutionUpdateConfig":{"shape":"SolutionUpdateConfig"}, + "status":{"shape":"Status"}, + "performAutoTraining":{"shape":"PerformAutoTraining"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"}, + "failureReason":{"shape":"FailureReason"} + } + }, "SolutionVersion":{ "type":"structure", "members":{ @@ -3307,6 +3342,21 @@ "members":{ "recommenderArn":{"shape":"Arn"} } + }, + "UpdateSolutionRequest":{ + "type":"structure", + "required":["solutionArn"], + "members":{ + "solutionArn":{"shape":"Arn"}, + "performAutoTraining":{"shape":"PerformAutoTraining"}, + "solutionUpdateConfig":{"shape":"SolutionUpdateConfig"} + } + }, + "UpdateSolutionResponse":{ + "type":"structure", + "members":{ + "solutionArn":{"shape":"Arn"} + } } } } diff --git a/src/data/personalize/2018-05-22/api-2.json.php b/src/data/personalize/2018-05-22/api-2.json.php index 081f119240..1683b49b3c 100644 --- a/src/data/personalize/2018-05-22/api-2.json.php +++ b/src/data/personalize/2018-05-22/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-05-22', 'endpointPrefix' => 'personalize', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceFullName' => 'Amazon Personalize', 'serviceId' => 'Personalize', 'signatureVersion' => 'v4', 'signingName' => 'personalize', 'targetPrefix' => 'AmazonPersonalize', 'uid' => 'personalize-2018-05-22', ], 'operations' => [ 'CreateBatchInferenceJob' => [ 'name' => 'CreateBatchInferenceJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBatchInferenceJobRequest', ], 'output' => [ 'shape' => 'CreateBatchInferenceJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateBatchSegmentJob' => [ 'name' => 'CreateBatchSegmentJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBatchSegmentJobRequest', ], 'output' => [ 'shape' => 'CreateBatchSegmentJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateCampaign' => [ 'name' => 'CreateCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCampaignRequest', ], 'output' => [ 'shape' => 'CreateCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDataDeletionJob' => [ 'name' => 'CreateDataDeletionJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataDeletionJobRequest', ], 'output' => [ 'shape' => 'CreateDataDeletionJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateDataset' => [ 'name' => 'CreateDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetRequest', ], 'output' => [ 'shape' => 'CreateDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDatasetExportJob' => [ 'name' => 'CreateDatasetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetExportJobRequest', ], 'output' => [ 'shape' => 'CreateDatasetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDatasetGroup' => [ 'name' => 'CreateDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetGroupRequest', ], 'output' => [ 'shape' => 'CreateDatasetGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateDatasetImportJob' => [ 'name' => 'CreateDatasetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetImportJobRequest', ], 'output' => [ 'shape' => 'CreateDatasetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateEventTracker' => [ 'name' => 'CreateEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventTrackerRequest', ], 'output' => [ 'shape' => 'CreateEventTrackerResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateFilter' => [ 'name' => 'CreateFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFilterRequest', ], 'output' => [ 'shape' => 'CreateFilterResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateMetricAttribution' => [ 'name' => 'CreateMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMetricAttributionRequest', ], 'output' => [ 'shape' => 'CreateMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateRecommender' => [ 'name' => 'CreateRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRecommenderRequest', ], 'output' => [ 'shape' => 'CreateRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateSchema' => [ 'name' => 'CreateSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSchemaRequest', ], 'output' => [ 'shape' => 'CreateSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateSolution' => [ 'name' => 'CreateSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSolutionRequest', ], 'output' => [ 'shape' => 'CreateSolutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateSolutionVersion' => [ 'name' => 'CreateSolutionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSolutionVersionRequest', ], 'output' => [ 'shape' => 'CreateSolutionVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], ], ], 'DeleteCampaign' => [ 'name' => 'DeleteCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCampaignRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteDataset' => [ 'name' => 'DeleteDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDatasetRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteDatasetGroup' => [ 'name' => 'DeleteDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDatasetGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteEventTracker' => [ 'name' => 'DeleteEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventTrackerRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteFilter' => [ 'name' => 'DeleteFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFilterRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteMetricAttribution' => [ 'name' => 'DeleteMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMetricAttributionRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteRecommender' => [ 'name' => 'DeleteRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRecommenderRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteSchema' => [ 'name' => 'DeleteSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSchemaRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteSolution' => [ 'name' => 'DeleteSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSolutionRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmRequest', ], 'output' => [ 'shape' => 'DescribeAlgorithmResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeBatchInferenceJob' => [ 'name' => 'DescribeBatchInferenceJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBatchInferenceJobRequest', ], 'output' => [ 'shape' => 'DescribeBatchInferenceJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeBatchSegmentJob' => [ 'name' => 'DescribeBatchSegmentJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBatchSegmentJobRequest', ], 'output' => [ 'shape' => 'DescribeBatchSegmentJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeCampaign' => [ 'name' => 'DescribeCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCampaignRequest', ], 'output' => [ 'shape' => 'DescribeCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDataDeletionJob' => [ 'name' => 'DescribeDataDeletionJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataDeletionJobRequest', ], 'output' => [ 'shape' => 'DescribeDataDeletionJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDataset' => [ 'name' => 'DescribeDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetRequest', ], 'output' => [ 'shape' => 'DescribeDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetExportJob' => [ 'name' => 'DescribeDatasetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetExportJobRequest', ], 'output' => [ 'shape' => 'DescribeDatasetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetGroup' => [ 'name' => 'DescribeDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetGroupRequest', ], 'output' => [ 'shape' => 'DescribeDatasetGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetImportJob' => [ 'name' => 'DescribeDatasetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetImportJobRequest', ], 'output' => [ 'shape' => 'DescribeDatasetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeEventTracker' => [ 'name' => 'DescribeEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventTrackerRequest', ], 'output' => [ 'shape' => 'DescribeEventTrackerResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeFeatureTransformation' => [ 'name' => 'DescribeFeatureTransformation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureTransformationRequest', ], 'output' => [ 'shape' => 'DescribeFeatureTransformationResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeFilter' => [ 'name' => 'DescribeFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFilterRequest', ], 'output' => [ 'shape' => 'DescribeFilterResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeMetricAttribution' => [ 'name' => 'DescribeMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMetricAttributionRequest', ], 'output' => [ 'shape' => 'DescribeMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeRecipe' => [ 'name' => 'DescribeRecipe', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecipeRequest', ], 'output' => [ 'shape' => 'DescribeRecipeResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeRecommender' => [ 'name' => 'DescribeRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecommenderRequest', ], 'output' => [ 'shape' => 'DescribeRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSchema' => [ 'name' => 'DescribeSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSchemaRequest', ], 'output' => [ 'shape' => 'DescribeSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSolution' => [ 'name' => 'DescribeSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSolutionRequest', ], 'output' => [ 'shape' => 'DescribeSolutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSolutionVersion' => [ 'name' => 'DescribeSolutionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSolutionVersionRequest', ], 'output' => [ 'shape' => 'DescribeSolutionVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'GetSolutionMetrics' => [ 'name' => 'GetSolutionMetrics', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSolutionMetricsRequest', ], 'output' => [ 'shape' => 'GetSolutionMetricsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'ListBatchInferenceJobs' => [ 'name' => 'ListBatchInferenceJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBatchInferenceJobsRequest', ], 'output' => [ 'shape' => 'ListBatchInferenceJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListBatchSegmentJobs' => [ 'name' => 'ListBatchSegmentJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBatchSegmentJobsRequest', ], 'output' => [ 'shape' => 'ListBatchSegmentJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListCampaigns' => [ 'name' => 'ListCampaigns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCampaignsRequest', ], 'output' => [ 'shape' => 'ListCampaignsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDataDeletionJobs' => [ 'name' => 'ListDataDeletionJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataDeletionJobsRequest', ], 'output' => [ 'shape' => 'ListDataDeletionJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetExportJobs' => [ 'name' => 'ListDatasetExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetExportJobsRequest', ], 'output' => [ 'shape' => 'ListDatasetExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetGroups' => [ 'name' => 'ListDatasetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetGroupsRequest', ], 'output' => [ 'shape' => 'ListDatasetGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetImportJobs' => [ 'name' => 'ListDatasetImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetImportJobsRequest', ], 'output' => [ 'shape' => 'ListDatasetImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasets' => [ 'name' => 'ListDatasets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetsRequest', ], 'output' => [ 'shape' => 'ListDatasetsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListEventTrackers' => [ 'name' => 'ListEventTrackers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEventTrackersRequest', ], 'output' => [ 'shape' => 'ListEventTrackersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListFilters' => [ 'name' => 'ListFilters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFiltersRequest', ], 'output' => [ 'shape' => 'ListFiltersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListMetricAttributionMetrics' => [ 'name' => 'ListMetricAttributionMetrics', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMetricAttributionMetricsRequest', ], 'output' => [ 'shape' => 'ListMetricAttributionMetricsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListMetricAttributions' => [ 'name' => 'ListMetricAttributions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMetricAttributionsRequest', ], 'output' => [ 'shape' => 'ListMetricAttributionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListRecipes' => [ 'name' => 'ListRecipes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecipesRequest', ], 'output' => [ 'shape' => 'ListRecipesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidInputException', ], ], 'idempotent' => true, ], 'ListRecommenders' => [ 'name' => 'ListRecommenders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecommendersRequest', ], 'output' => [ 'shape' => 'ListRecommendersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSchemas' => [ 'name' => 'ListSchemas', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSchemasRequest', ], 'output' => [ 'shape' => 'ListSchemasResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSolutionVersions' => [ 'name' => 'ListSolutionVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSolutionVersionsRequest', ], 'output' => [ 'shape' => 'ListSolutionVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSolutions' => [ 'name' => 'ListSolutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSolutionsRequest', ], 'output' => [ 'shape' => 'ListSolutionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'StartRecommender' => [ 'name' => 'StartRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRecommenderRequest', ], 'output' => [ 'shape' => 'StartRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'StopRecommender' => [ 'name' => 'StopRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRecommenderRequest', ], 'output' => [ 'shape' => 'StopRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'StopSolutionVersionCreation' => [ 'name' => 'StopSolutionVersionCreation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopSolutionVersionCreationRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagKeysException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'UpdateCampaign' => [ 'name' => 'UpdateCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCampaignRequest', ], 'output' => [ 'shape' => 'UpdateCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'UpdateDataset' => [ 'name' => 'UpdateDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDatasetRequest', ], 'output' => [ 'shape' => 'UpdateDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'UpdateMetricAttribution' => [ 'name' => 'UpdateMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMetricAttributionRequest', ], 'output' => [ 'shape' => 'UpdateMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], ], ], 'UpdateRecommender' => [ 'name' => 'UpdateRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRecommenderRequest', ], 'output' => [ 'shape' => 'UpdateRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'AccountId' => [ 'type' => 'string', 'max' => 256, ], 'Algorithm' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'algorithmArn' => [ 'shape' => 'Arn', ], 'algorithmImage' => [ 'shape' => 'AlgorithmImage', ], 'defaultHyperParameters' => [ 'shape' => 'HyperParameters', ], 'defaultHyperParameterRanges' => [ 'shape' => 'DefaultHyperParameterRanges', ], 'defaultResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'trainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'roleArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'AlgorithmImage' => [ 'type' => 'structure', 'required' => [ 'dockerURI', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'dockerURI' => [ 'shape' => 'DockerURI', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:([a-z\\d-]+):personalize:.*:.*:.+', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, ], 'AutoMLConfig' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'MetricName', ], 'recipeList' => [ 'shape' => 'ArnList', ], ], ], 'AutoMLResult' => [ 'type' => 'structure', 'members' => [ 'bestRecipeArn' => [ 'shape' => 'Arn', ], ], ], 'AutoTrainingConfig' => [ 'type' => 'structure', 'members' => [ 'schedulingExpression' => [ 'shape' => 'SchedulingExpression', ], ], ], 'AvroSchema' => [ 'type' => 'string', 'max' => 20000, ], 'BatchInferenceJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchInferenceJobInput', ], 'jobOutput' => [ 'shape' => 'BatchInferenceJobOutput', ], 'batchInferenceJobConfig' => [ 'shape' => 'BatchInferenceJobConfig', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], 'themeGenerationConfig' => [ 'shape' => 'ThemeGenerationConfig', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'BatchInferenceJobConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], ], ], 'BatchInferenceJobInput' => [ 'type' => 'structure', 'required' => [ 's3DataSource', ], 'members' => [ 's3DataSource' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchInferenceJobMode' => [ 'type' => 'string', 'enum' => [ 'BATCH_INFERENCE', 'THEME_GENERATION', ], ], 'BatchInferenceJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchInferenceJobSummary' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], ], ], 'BatchInferenceJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchInferenceJobSummary', ], 'max' => 100, ], 'BatchSegmentJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchSegmentJobInput', ], 'jobOutput' => [ 'shape' => 'BatchSegmentJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'BatchSegmentJobInput' => [ 'type' => 'structure', 'required' => [ 's3DataSource', ], 'members' => [ 's3DataSource' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchSegmentJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchSegmentJobSummary' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'BatchSegmentJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchSegmentJobSummary', ], 'max' => 100, ], 'Boolean' => [ 'type' => 'boolean', ], 'Campaign' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'campaignArn' => [ 'shape' => 'Arn', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestCampaignUpdate' => [ 'shape' => 'CampaignUpdateSummary', ], ], ], 'CampaignConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], 'enableMetadataWithRecommendations' => [ 'shape' => 'Boolean', ], 'syncWithLatestSolutionVersion' => [ 'shape' => 'Boolean', ], ], ], 'CampaignSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'campaignArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'CampaignUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'Campaigns' => [ 'type' => 'list', 'member' => [ 'shape' => 'CampaignSummary', ], 'max' => 100, ], 'CategoricalHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'values' => [ 'shape' => 'CategoricalValues', ], ], ], 'CategoricalHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalHyperParameterRange', ], 'max' => 100, ], 'CategoricalValue' => [ 'type' => 'string', 'max' => 1000, ], 'CategoricalValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalValue', ], 'max' => 100, ], 'ColumnName' => [ 'type' => 'string', 'max' => 150, ], 'ColumnNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnName', ], 'max' => 50, ], 'ContinuousHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'ContinuousMinValue', ], 'maxValue' => [ 'shape' => 'ContinuousMaxValue', ], ], ], 'ContinuousHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousHyperParameterRange', ], 'max' => 100, ], 'ContinuousMaxValue' => [ 'type' => 'double', 'min' => -1000000, ], 'ContinuousMinValue' => [ 'type' => 'double', 'min' => -1000000, ], 'CreateBatchInferenceJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'solutionVersionArn', 'jobInput', 'jobOutput', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchInferenceJobInput', ], 'jobOutput' => [ 'shape' => 'BatchInferenceJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'batchInferenceJobConfig' => [ 'shape' => 'BatchInferenceJobConfig', ], 'tags' => [ 'shape' => 'Tags', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], 'themeGenerationConfig' => [ 'shape' => 'ThemeGenerationConfig', ], ], ], 'CreateBatchInferenceJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateBatchSegmentJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'solutionVersionArn', 'jobInput', 'jobOutput', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchSegmentJobInput', ], 'jobOutput' => [ 'shape' => 'BatchSegmentJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateBatchSegmentJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'solutionVersionArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDataDeletionJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetGroupArn', 'dataSource', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDataDeletionJobResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetArn', 'roleArn', 'jobOutput', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'ingestionMode' => [ 'shape' => 'IngestionMode', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'jobOutput' => [ 'shape' => 'DatasetExportJobOutput', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'domain' => [ 'shape' => 'Domain', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'CreateDatasetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetArn', 'dataSource', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], 'importMode' => [ 'shape' => 'ImportMode', ], 'publishAttributionMetricsToS3' => [ 'shape' => 'Boolean', ], ], ], 'CreateDatasetImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'schemaArn', 'datasetGroupArn', 'datasetType', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'CreateEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateEventTrackerResponse' => [ 'type' => 'structure', 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'trackingId' => [ 'shape' => 'TrackingId', ], ], ], 'CreateFilterRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'filterExpression', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'filterExpression' => [ 'shape' => 'FilterExpression', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateFilterResponse' => [ 'type' => 'structure', 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'CreateMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'metrics', 'metricsOutputConfig', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'metrics' => [ 'shape' => 'MetricAttributes', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], ], ], 'CreateMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'CreateRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'recipeArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'schema', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schema' => [ 'shape' => 'AvroSchema', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'CreateSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'performHPO' => [ 'shape' => 'Boolean', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateSolutionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSolutionVersionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateSolutionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'DataDeletionJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'Status', ], 'numDeleted' => [ 'shape' => 'Integer', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DataDeletionJobSummary' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DataDeletionJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataDeletionJobSummary', ], 'max' => 100, ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'dataLocation' => [ 'shape' => 'S3Location', ], ], ], 'Dataset' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestDatasetUpdate' => [ 'shape' => 'DatasetUpdateSummary', ], 'trackingId' => [ 'shape' => 'TrackingId', ], ], ], 'DatasetExportJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetExportJobArn' => [ 'shape' => 'Arn', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'ingestionMode' => [ 'shape' => 'IngestionMode', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'jobOutput' => [ 'shape' => 'DatasetExportJobOutput', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DatasetExportJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'DatasetExportJobSummary' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DatasetExportJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetExportJobSummary', ], 'max' => 100, ], 'DatasetGroup' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetGroupSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetGroupSummary', ], 'max' => 100, ], 'DatasetImportJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetImportJobArn' => [ 'shape' => 'Arn', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'importMode' => [ 'shape' => 'ImportMode', ], 'publishAttributionMetricsToS3' => [ 'shape' => 'Boolean', ], ], ], 'DatasetImportJobSummary' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'importMode' => [ 'shape' => 'ImportMode', ], ], ], 'DatasetImportJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetImportJobSummary', ], 'max' => 100, ], 'DatasetSchema' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'schema' => [ 'shape' => 'AvroSchema', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetSchemaSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'DatasetType' => [ 'type' => 'string', 'max' => 256, ], 'DatasetUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'Datasets' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetSummary', ], 'max' => 100, ], 'Date' => [ 'type' => 'timestamp', ], 'DefaultCategoricalHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'values' => [ 'shape' => 'CategoricalValues', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultCategoricalHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultCategoricalHyperParameterRange', ], 'max' => 100, ], 'DefaultContinuousHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'ContinuousMinValue', ], 'maxValue' => [ 'shape' => 'ContinuousMaxValue', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultContinuousHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultContinuousHyperParameterRange', ], 'max' => 100, ], 'DefaultHyperParameterRanges' => [ 'type' => 'structure', 'members' => [ 'integerHyperParameterRanges' => [ 'shape' => 'DefaultIntegerHyperParameterRanges', ], 'continuousHyperParameterRanges' => [ 'shape' => 'DefaultContinuousHyperParameterRanges', ], 'categoricalHyperParameterRanges' => [ 'shape' => 'DefaultCategoricalHyperParameterRanges', ], ], ], 'DefaultIntegerHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'IntegerMinValue', ], 'maxValue' => [ 'shape' => 'IntegerMaxValue', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultIntegerHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultIntegerHyperParameterRange', ], 'max' => 100, ], 'DeleteCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'datasetGroupArn', ], 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'eventTrackerArn', ], 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteFilterRequest' => [ 'type' => 'structure', 'required' => [ 'filterArn', ], 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'metricAttributionArn', ], 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'schemaArn', ], 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAlgorithmRequest' => [ 'type' => 'structure', 'required' => [ 'algorithmArn', ], 'members' => [ 'algorithmArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAlgorithmResponse' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'Algorithm', ], ], ], 'DescribeBatchInferenceJobRequest' => [ 'type' => 'structure', 'required' => [ 'batchInferenceJobArn', ], 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeBatchInferenceJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJob' => [ 'shape' => 'BatchInferenceJob', ], ], ], 'DescribeBatchSegmentJobRequest' => [ 'type' => 'structure', 'required' => [ 'batchSegmentJobArn', ], 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeBatchSegmentJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJob' => [ 'shape' => 'BatchSegmentJob', ], ], ], 'DescribeCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaign' => [ 'shape' => 'Campaign', ], ], ], 'DescribeDataDeletionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataDeletionJobArn', ], 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDataDeletionJobResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJob' => [ 'shape' => 'DataDeletionJob', ], ], ], 'DescribeDatasetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'datasetExportJobArn', ], 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJob' => [ 'shape' => 'DatasetExportJob', ], ], ], 'DescribeDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'datasetGroupArn', ], 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroup' => [ 'shape' => 'DatasetGroup', ], ], ], 'DescribeDatasetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'datasetImportJobArn', ], 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJob' => [ 'shape' => 'DatasetImportJob', ], ], ], 'DescribeDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'dataset' => [ 'shape' => 'Dataset', ], ], ], 'DescribeEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'eventTrackerArn', ], 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeEventTrackerResponse' => [ 'type' => 'structure', 'members' => [ 'eventTracker' => [ 'shape' => 'EventTracker', ], ], ], 'DescribeFeatureTransformationRequest' => [ 'type' => 'structure', 'required' => [ 'featureTransformationArn', ], 'members' => [ 'featureTransformationArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeFeatureTransformationResponse' => [ 'type' => 'structure', 'members' => [ 'featureTransformation' => [ 'shape' => 'FeatureTransformation', ], ], ], 'DescribeFilterRequest' => [ 'type' => 'structure', 'required' => [ 'filterArn', ], 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeFilterResponse' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'Filter', ], ], ], 'DescribeMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'metricAttributionArn', ], 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttribution' => [ 'shape' => 'MetricAttribution', ], ], ], 'DescribeRecipeRequest' => [ 'type' => 'structure', 'required' => [ 'recipeArn', ], 'members' => [ 'recipeArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRecipeResponse' => [ 'type' => 'structure', 'members' => [ 'recipe' => [ 'shape' => 'Recipe', ], ], ], 'DescribeRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommender' => [ 'shape' => 'Recommender', ], ], ], 'DescribeSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'schemaArn', ], 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'schema' => [ 'shape' => 'DatasetSchema', ], ], ], 'DescribeSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSolutionResponse' => [ 'type' => 'structure', 'members' => [ 'solution' => [ 'shape' => 'Solution', ], ], ], 'DescribeSolutionVersionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSolutionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersion' => [ 'shape' => 'SolutionVersion', ], ], ], 'Description' => [ 'type' => 'string', ], 'DockerURI' => [ 'type' => 'string', 'max' => 256, ], 'Domain' => [ 'type' => 'string', 'enum' => [ 'ECOMMERCE', 'VIDEO_ON_DEMAND', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EventTracker' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'accountId' => [ 'shape' => 'AccountId', ], 'trackingId' => [ 'shape' => 'TrackingId', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'EventTrackerSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'EventTrackers' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventTrackerSummary', ], 'max' => 100, ], 'EventType' => [ 'type' => 'string', 'max' => 256, ], 'EventValueThreshold' => [ 'type' => 'string', 'max' => 256, ], 'ExcludedDatasetColumns' => [ 'type' => 'map', 'key' => [ 'shape' => 'DatasetType', ], 'value' => [ 'shape' => 'ColumnNamesList', ], 'max' => 3, ], 'FailureReason' => [ 'type' => 'string', ], 'FeatureTransformation' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'featureTransformationArn' => [ 'shape' => 'Arn', ], 'defaultParameters' => [ 'shape' => 'FeaturizationParameters', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], ], ], 'FeatureTransformationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'FeaturizationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'FieldsForThemeGeneration' => [ 'type' => 'structure', 'required' => [ 'itemName', ], 'members' => [ 'itemName' => [ 'shape' => 'ColumnName', ], ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'filterArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'filterExpression' => [ 'shape' => 'FilterExpression', ], 'status' => [ 'shape' => 'Status', ], ], ], 'FilterExpression' => [ 'type' => 'string', 'max' => 2500, 'min' => 1, 'sensitive' => true, ], 'FilterSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'filterArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'status' => [ 'shape' => 'Status', ], ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterSummary', ], 'max' => 100, ], 'GetSolutionMetricsRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'GetSolutionMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'metrics' => [ 'shape' => 'Metrics', ], ], ], 'HPOConfig' => [ 'type' => 'structure', 'members' => [ 'hpoObjective' => [ 'shape' => 'HPOObjective', ], 'hpoResourceConfig' => [ 'shape' => 'HPOResourceConfig', ], 'algorithmHyperParameterRanges' => [ 'shape' => 'HyperParameterRanges', ], ], ], 'HPOObjective' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'HPOObjectiveType', ], 'metricName' => [ 'shape' => 'MetricName', ], 'metricRegex' => [ 'shape' => 'MetricRegex', ], ], ], 'HPOObjectiveType' => [ 'type' => 'string', 'max' => 256, ], 'HPOResource' => [ 'type' => 'string', 'max' => 256, ], 'HPOResourceConfig' => [ 'type' => 'structure', 'members' => [ 'maxNumberOfTrainingJobs' => [ 'shape' => 'HPOResource', ], 'maxParallelTrainingJobs' => [ 'shape' => 'HPOResource', ], ], ], 'HyperParameterRanges' => [ 'type' => 'structure', 'members' => [ 'integerHyperParameterRanges' => [ 'shape' => 'IntegerHyperParameterRanges', ], 'continuousHyperParameterRanges' => [ 'shape' => 'ContinuousHyperParameterRanges', ], 'categoricalHyperParameterRanges' => [ 'shape' => 'CategoricalHyperParameterRanges', ], ], ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'ImportMode' => [ 'type' => 'string', 'enum' => [ 'FULL', 'INCREMENTAL', ], ], 'IngestionMode' => [ 'type' => 'string', 'enum' => [ 'BULK', 'PUT', 'ALL', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'IntegerMinValue', ], 'maxValue' => [ 'shape' => 'IntegerMaxValue', ], ], ], 'IntegerHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerHyperParameterRange', ], 'max' => 100, ], 'IntegerMaxValue' => [ 'type' => 'integer', 'max' => 1000000, ], 'IntegerMinValue' => [ 'type' => 'integer', 'min' => -1000000, ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ItemAttribute' => [ 'type' => 'string', 'max' => 150, 'min' => 1, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws.*:kms:.*:[0-9]{12}:key/.*', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListBatchInferenceJobsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListBatchInferenceJobsResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobs' => [ 'shape' => 'BatchInferenceJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBatchSegmentJobsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListBatchSegmentJobsResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobs' => [ 'shape' => 'BatchSegmentJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCampaignsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListCampaignsResponse' => [ 'type' => 'structure', 'members' => [ 'campaigns' => [ 'shape' => 'Campaigns', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataDeletionJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDataDeletionJobsResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobs' => [ 'shape' => 'DataDeletionJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetExportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobs' => [ 'shape' => 'DatasetExportJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroups' => [ 'shape' => 'DatasetGroups', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobs' => [ 'shape' => 'DatasetImportJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetsResponse' => [ 'type' => 'structure', 'members' => [ 'datasets' => [ 'shape' => 'Datasets', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEventTrackersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListEventTrackersResponse' => [ 'type' => 'structure', 'members' => [ 'eventTrackers' => [ 'shape' => 'EventTrackers', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFiltersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListFiltersResponse' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMetricAttributionMetricsRequest' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMetricAttributionMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'metrics' => [ 'shape' => 'MetricAttributes', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMetricAttributionsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMetricAttributionsResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributions' => [ 'shape' => 'MetricAttributions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecipesRequest' => [ 'type' => 'structure', 'members' => [ 'recipeProvider' => [ 'shape' => 'RecipeProvider', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'ListRecipesResponse' => [ 'type' => 'structure', 'members' => [ 'recipes' => [ 'shape' => 'Recipes', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecommendersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListRecommendersResponse' => [ 'type' => 'structure', 'members' => [ 'recommenders' => [ 'shape' => 'Recommenders', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSchemasRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSchemasResponse' => [ 'type' => 'structure', 'members' => [ 'schemas' => [ 'shape' => 'Schemas', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSolutionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSolutionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersions' => [ 'shape' => 'SolutionVersions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSolutionsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSolutionsResponse' => [ 'type' => 'structure', 'members' => [ 'solutions' => [ 'shape' => 'Solutions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MetricAttribute' => [ 'type' => 'structure', 'required' => [ 'eventType', 'metricName', 'expression', ], 'members' => [ 'eventType' => [ 'shape' => 'EventType', ], 'metricName' => [ 'shape' => 'MetricName', ], 'expression' => [ 'shape' => 'MetricExpression', ], ], ], 'MetricAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricAttribute', ], 'max' => 10, ], 'MetricAttributesNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricName', ], 'max' => 10, ], 'MetricAttribution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'MetricAttributionOutput' => [ 'type' => 'structure', 'required' => [ 'roleArn', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MetricAttributionSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'MetricAttributions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricAttributionSummary', ], 'max' => 100, ], 'MetricExpression' => [ 'type' => 'string', 'max' => 256, ], 'MetricName' => [ 'type' => 'string', 'max' => 256, ], 'MetricRegex' => [ 'type' => 'string', 'max' => 256, ], 'MetricValue' => [ 'type' => 'double', ], 'Metrics' => [ 'type' => 'map', 'key' => [ 'shape' => 'MetricName', ], 'value' => [ 'shape' => 'MetricValue', ], 'max' => 100, ], 'Name' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9\\-_]*', ], 'NextToken' => [ 'type' => 'string', 'max' => 1500, 'pattern' => '\\p{ASCII}{0,1500}', ], 'NumBatchResults' => [ 'type' => 'integer', ], 'ObjectiveSensitivity' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', 'OFF', ], ], 'OptimizationObjective' => [ 'type' => 'structure', 'members' => [ 'itemAttribute' => [ 'shape' => 'ItemAttribute', ], 'objectiveSensitivity' => [ 'shape' => 'ObjectiveSensitivity', ], ], ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, ], 'ParameterValue' => [ 'type' => 'string', 'max' => 1000, ], 'PerformAutoML' => [ 'type' => 'boolean', ], 'PerformAutoTraining' => [ 'type' => 'boolean', 'box' => true, ], 'PerformHPO' => [ 'type' => 'boolean', ], 'Recipe' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'algorithmArn' => [ 'shape' => 'Arn', ], 'featureTransformationArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'description' => [ 'shape' => 'Description', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'recipeType' => [ 'shape' => 'RecipeType', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'RecipeProvider' => [ 'type' => 'string', 'enum' => [ 'SERVICE', ], ], 'RecipeSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'RecipeType' => [ 'type' => 'string', 'max' => 256, ], 'Recipes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecipeSummary', ], 'max' => 100, ], 'Recommender' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'latestRecommenderUpdate' => [ 'shape' => 'RecommenderUpdateSummary', ], 'modelMetrics' => [ 'shape' => 'Metrics', ], ], ], 'RecommenderConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], 'minRecommendationRequestsPerSecond' => [ 'shape' => 'TransactionsPerSecond', ], 'trainingDataConfig' => [ 'shape' => 'TrainingDataConfig', ], 'enableMetadataWithRecommendations' => [ 'shape' => 'Boolean', ], ], ], 'RecommenderSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recommenderArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'RecommenderUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'Recommenders' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommenderSummary', ], 'max' => 100, ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceConfig' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'RoleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+', ], 'S3DataConfig' => [ 'type' => 'structure', 'required' => [ 'path', ], 'members' => [ 'path' => [ 'shape' => 'S3Location', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'S3Location' => [ 'type' => 'string', 'max' => 256, 'pattern' => '(s3|http|https)://.+', ], 'SchedulingExpression' => [ 'type' => 'string', 'max' => 16, 'min' => 1, 'pattern' => 'rate\\(\\d+ days?\\)', ], 'Schemas' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetSchemaSummary', ], 'max' => 100, ], 'Solution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'performHPO' => [ 'shape' => 'PerformHPO', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'autoMLResult' => [ 'shape' => 'AutoMLResult', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestSolutionVersion' => [ 'shape' => 'SolutionVersionSummary', ], ], ], 'SolutionConfig' => [ 'type' => 'structure', 'members' => [ 'eventValueThreshold' => [ 'shape' => 'EventValueThreshold', ], 'hpoConfig' => [ 'shape' => 'HPOConfig', ], 'algorithmHyperParameters' => [ 'shape' => 'HyperParameters', ], 'featureTransformationParameters' => [ 'shape' => 'FeatureTransformationParameters', ], 'autoMLConfig' => [ 'shape' => 'AutoMLConfig', ], 'optimizationObjective' => [ 'shape' => 'OptimizationObjective', ], 'trainingDataConfig' => [ 'shape' => 'TrainingDataConfig', ], 'autoTrainingConfig' => [ 'shape' => 'AutoTrainingConfig', ], ], ], 'SolutionSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'recipeArn' => [ 'shape' => 'Arn', ], ], ], 'SolutionVersion' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'performHPO' => [ 'shape' => 'PerformHPO', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'trainingHours' => [ 'shape' => 'TrainingHours', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'tunedHPOParams' => [ 'shape' => 'TunedHPOParams', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'trainingType' => [ 'shape' => 'TrainingType', ], ], ], 'SolutionVersionSummary' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'trainingType' => [ 'shape' => 'TrainingType', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'SolutionVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SolutionVersionSummary', ], 'max' => 100, ], 'Solutions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SolutionSummary', ], 'max' => 100, ], 'StartRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StartRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'Status' => [ 'type' => 'string', 'max' => 256, ], 'StopRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StopRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StopSolutionVersionCreationRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'tagKey', 'tagValue', ], 'members' => [ 'tagKey' => [ 'shape' => 'TagKey', ], 'tagValue' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'ThemeGenerationConfig' => [ 'type' => 'structure', 'required' => [ 'fieldsForThemeGeneration', ], 'members' => [ 'fieldsForThemeGeneration' => [ 'shape' => 'FieldsForThemeGeneration', ], ], ], 'TooManyTagKeysException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TrackingId' => [ 'type' => 'string', 'max' => 256, ], 'TrainingDataConfig' => [ 'type' => 'structure', 'members' => [ 'excludedDatasetColumns' => [ 'shape' => 'ExcludedDatasetColumns', ], ], ], 'TrainingHours' => [ 'type' => 'double', 'min' => 0, ], 'TrainingInputMode' => [ 'type' => 'string', 'max' => 256, ], 'TrainingMode' => [ 'type' => 'string', 'enum' => [ 'FULL', 'UPDATE', 'AUTOTRAIN', ], ], 'TrainingType' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC', 'MANUAL', ], ], 'TransactionsPerSecond' => [ 'type' => 'integer', 'min' => 1, ], 'Tunable' => [ 'type' => 'boolean', ], 'TunedHPOParams' => [ 'type' => 'structure', 'members' => [ 'algorithmHyperParameters' => [ 'shape' => 'HyperParameters', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], ], ], 'UpdateCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', 'schemaArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateMetricAttributionRequest' => [ 'type' => 'structure', 'members' => [ 'addMetrics' => [ 'shape' => 'MetricAttributes', ], 'removeMetrics' => [ 'shape' => 'MetricAttributesNamesList', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', 'recommenderConfig', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], ], ], 'UpdateRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-05-22', 'endpointPrefix' => 'personalize', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceFullName' => 'Amazon Personalize', 'serviceId' => 'Personalize', 'signatureVersion' => 'v4', 'signingName' => 'personalize', 'targetPrefix' => 'AmazonPersonalize', 'uid' => 'personalize-2018-05-22', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CreateBatchInferenceJob' => [ 'name' => 'CreateBatchInferenceJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBatchInferenceJobRequest', ], 'output' => [ 'shape' => 'CreateBatchInferenceJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateBatchSegmentJob' => [ 'name' => 'CreateBatchSegmentJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBatchSegmentJobRequest', ], 'output' => [ 'shape' => 'CreateBatchSegmentJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateCampaign' => [ 'name' => 'CreateCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCampaignRequest', ], 'output' => [ 'shape' => 'CreateCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDataDeletionJob' => [ 'name' => 'CreateDataDeletionJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataDeletionJobRequest', ], 'output' => [ 'shape' => 'CreateDataDeletionJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateDataset' => [ 'name' => 'CreateDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetRequest', ], 'output' => [ 'shape' => 'CreateDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDatasetExportJob' => [ 'name' => 'CreateDatasetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetExportJobRequest', ], 'output' => [ 'shape' => 'CreateDatasetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateDatasetGroup' => [ 'name' => 'CreateDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetGroupRequest', ], 'output' => [ 'shape' => 'CreateDatasetGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateDatasetImportJob' => [ 'name' => 'CreateDatasetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDatasetImportJobRequest', ], 'output' => [ 'shape' => 'CreateDatasetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateEventTracker' => [ 'name' => 'CreateEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventTrackerRequest', ], 'output' => [ 'shape' => 'CreateEventTrackerResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateFilter' => [ 'name' => 'CreateFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFilterRequest', ], 'output' => [ 'shape' => 'CreateFilterResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateMetricAttribution' => [ 'name' => 'CreateMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMetricAttributionRequest', ], 'output' => [ 'shape' => 'CreateMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateRecommender' => [ 'name' => 'CreateRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRecommenderRequest', ], 'output' => [ 'shape' => 'CreateRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], 'idempotent' => true, ], 'CreateSchema' => [ 'name' => 'CreateSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSchemaRequest', ], 'output' => [ 'shape' => 'CreateSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateSolution' => [ 'name' => 'CreateSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSolutionRequest', ], 'output' => [ 'shape' => 'CreateSolutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'CreateSolutionVersion' => [ 'name' => 'CreateSolutionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSolutionVersionRequest', ], 'output' => [ 'shape' => 'CreateSolutionVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], ], ], 'DeleteCampaign' => [ 'name' => 'DeleteCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCampaignRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteDataset' => [ 'name' => 'DeleteDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDatasetRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteDatasetGroup' => [ 'name' => 'DeleteDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDatasetGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteEventTracker' => [ 'name' => 'DeleteEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventTrackerRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteFilter' => [ 'name' => 'DeleteFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFilterRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteMetricAttribution' => [ 'name' => 'DeleteMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMetricAttributionRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteRecommender' => [ 'name' => 'DeleteRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRecommenderRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteSchema' => [ 'name' => 'DeleteSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSchemaRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DeleteSolution' => [ 'name' => 'DeleteSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSolutionRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmRequest', ], 'output' => [ 'shape' => 'DescribeAlgorithmResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeBatchInferenceJob' => [ 'name' => 'DescribeBatchInferenceJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBatchInferenceJobRequest', ], 'output' => [ 'shape' => 'DescribeBatchInferenceJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeBatchSegmentJob' => [ 'name' => 'DescribeBatchSegmentJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBatchSegmentJobRequest', ], 'output' => [ 'shape' => 'DescribeBatchSegmentJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeCampaign' => [ 'name' => 'DescribeCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCampaignRequest', ], 'output' => [ 'shape' => 'DescribeCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDataDeletionJob' => [ 'name' => 'DescribeDataDeletionJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataDeletionJobRequest', ], 'output' => [ 'shape' => 'DescribeDataDeletionJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDataset' => [ 'name' => 'DescribeDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetRequest', ], 'output' => [ 'shape' => 'DescribeDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetExportJob' => [ 'name' => 'DescribeDatasetExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetExportJobRequest', ], 'output' => [ 'shape' => 'DescribeDatasetExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetGroup' => [ 'name' => 'DescribeDatasetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetGroupRequest', ], 'output' => [ 'shape' => 'DescribeDatasetGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeDatasetImportJob' => [ 'name' => 'DescribeDatasetImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDatasetImportJobRequest', ], 'output' => [ 'shape' => 'DescribeDatasetImportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeEventTracker' => [ 'name' => 'DescribeEventTracker', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventTrackerRequest', ], 'output' => [ 'shape' => 'DescribeEventTrackerResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeFeatureTransformation' => [ 'name' => 'DescribeFeatureTransformation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureTransformationRequest', ], 'output' => [ 'shape' => 'DescribeFeatureTransformationResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeFilter' => [ 'name' => 'DescribeFilter', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFilterRequest', ], 'output' => [ 'shape' => 'DescribeFilterResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeMetricAttribution' => [ 'name' => 'DescribeMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMetricAttributionRequest', ], 'output' => [ 'shape' => 'DescribeMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeRecipe' => [ 'name' => 'DescribeRecipe', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecipeRequest', ], 'output' => [ 'shape' => 'DescribeRecipeResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeRecommender' => [ 'name' => 'DescribeRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecommenderRequest', ], 'output' => [ 'shape' => 'DescribeRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSchema' => [ 'name' => 'DescribeSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSchemaRequest', ], 'output' => [ 'shape' => 'DescribeSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSolution' => [ 'name' => 'DescribeSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSolutionRequest', ], 'output' => [ 'shape' => 'DescribeSolutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'DescribeSolutionVersion' => [ 'name' => 'DescribeSolutionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSolutionVersionRequest', ], 'output' => [ 'shape' => 'DescribeSolutionVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'GetSolutionMetrics' => [ 'name' => 'GetSolutionMetrics', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSolutionMetricsRequest', ], 'output' => [ 'shape' => 'GetSolutionMetricsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'ListBatchInferenceJobs' => [ 'name' => 'ListBatchInferenceJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBatchInferenceJobsRequest', ], 'output' => [ 'shape' => 'ListBatchInferenceJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListBatchSegmentJobs' => [ 'name' => 'ListBatchSegmentJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBatchSegmentJobsRequest', ], 'output' => [ 'shape' => 'ListBatchSegmentJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListCampaigns' => [ 'name' => 'ListCampaigns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCampaignsRequest', ], 'output' => [ 'shape' => 'ListCampaignsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDataDeletionJobs' => [ 'name' => 'ListDataDeletionJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataDeletionJobsRequest', ], 'output' => [ 'shape' => 'ListDataDeletionJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetExportJobs' => [ 'name' => 'ListDatasetExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetExportJobsRequest', ], 'output' => [ 'shape' => 'ListDatasetExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetGroups' => [ 'name' => 'ListDatasetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetGroupsRequest', ], 'output' => [ 'shape' => 'ListDatasetGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasetImportJobs' => [ 'name' => 'ListDatasetImportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetImportJobsRequest', ], 'output' => [ 'shape' => 'ListDatasetImportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListDatasets' => [ 'name' => 'ListDatasets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDatasetsRequest', ], 'output' => [ 'shape' => 'ListDatasetsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListEventTrackers' => [ 'name' => 'ListEventTrackers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEventTrackersRequest', ], 'output' => [ 'shape' => 'ListEventTrackersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListFilters' => [ 'name' => 'ListFilters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFiltersRequest', ], 'output' => [ 'shape' => 'ListFiltersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListMetricAttributionMetrics' => [ 'name' => 'ListMetricAttributionMetrics', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMetricAttributionMetricsRequest', ], 'output' => [ 'shape' => 'ListMetricAttributionMetricsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListMetricAttributions' => [ 'name' => 'ListMetricAttributions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMetricAttributionsRequest', ], 'output' => [ 'shape' => 'ListMetricAttributionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListRecipes' => [ 'name' => 'ListRecipes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecipesRequest', ], 'output' => [ 'shape' => 'ListRecipesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidInputException', ], ], 'idempotent' => true, ], 'ListRecommenders' => [ 'name' => 'ListRecommenders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecommendersRequest', ], 'output' => [ 'shape' => 'ListRecommendersResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSchemas' => [ 'name' => 'ListSchemas', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSchemasRequest', ], 'output' => [ 'shape' => 'ListSchemasResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSolutionVersions' => [ 'name' => 'ListSolutionVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSolutionVersionsRequest', ], 'output' => [ 'shape' => 'ListSolutionVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListSolutions' => [ 'name' => 'ListSolutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSolutionsRequest', ], 'output' => [ 'shape' => 'ListSolutionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'InvalidNextTokenException', ], ], 'idempotent' => true, ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'StartRecommender' => [ 'name' => 'StartRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRecommenderRequest', ], 'output' => [ 'shape' => 'StartRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'StopRecommender' => [ 'name' => 'StopRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRecommenderRequest', ], 'output' => [ 'shape' => 'StopRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'StopSolutionVersionCreation' => [ 'name' => 'StopSolutionVersionCreation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopSolutionVersionCreationRequest', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagKeysException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'UpdateCampaign' => [ 'name' => 'UpdateCampaign', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCampaignRequest', ], 'output' => [ 'shape' => 'UpdateCampaignResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'UpdateDataset' => [ 'name' => 'UpdateDataset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDatasetRequest', ], 'output' => [ 'shape' => 'UpdateDatasetResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'UpdateMetricAttribution' => [ 'name' => 'UpdateMetricAttribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMetricAttributionRequest', ], 'output' => [ 'shape' => 'UpdateMetricAttributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], ], ], 'UpdateRecommender' => [ 'name' => 'UpdateRecommender', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRecommenderRequest', ], 'output' => [ 'shape' => 'UpdateRecommenderResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'UpdateSolution' => [ 'name' => 'UpdateSolution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSolutionRequest', ], 'output' => [ 'shape' => 'UpdateSolutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], ], ], ], 'shapes' => [ 'AccountId' => [ 'type' => 'string', 'max' => 256, ], 'Algorithm' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'algorithmArn' => [ 'shape' => 'Arn', ], 'algorithmImage' => [ 'shape' => 'AlgorithmImage', ], 'defaultHyperParameters' => [ 'shape' => 'HyperParameters', ], 'defaultHyperParameterRanges' => [ 'shape' => 'DefaultHyperParameterRanges', ], 'defaultResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'trainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'roleArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'AlgorithmImage' => [ 'type' => 'structure', 'required' => [ 'dockerURI', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'dockerURI' => [ 'shape' => 'DockerURI', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:([a-z\\d-]+):personalize:.*:.*:.+', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, ], 'AutoMLConfig' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'MetricName', ], 'recipeList' => [ 'shape' => 'ArnList', ], ], ], 'AutoMLResult' => [ 'type' => 'structure', 'members' => [ 'bestRecipeArn' => [ 'shape' => 'Arn', ], ], ], 'AutoTrainingConfig' => [ 'type' => 'structure', 'members' => [ 'schedulingExpression' => [ 'shape' => 'SchedulingExpression', ], ], ], 'AvroSchema' => [ 'type' => 'string', 'max' => 20000, ], 'BatchInferenceJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchInferenceJobInput', ], 'jobOutput' => [ 'shape' => 'BatchInferenceJobOutput', ], 'batchInferenceJobConfig' => [ 'shape' => 'BatchInferenceJobConfig', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], 'themeGenerationConfig' => [ 'shape' => 'ThemeGenerationConfig', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'BatchInferenceJobConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], ], ], 'BatchInferenceJobInput' => [ 'type' => 'structure', 'required' => [ 's3DataSource', ], 'members' => [ 's3DataSource' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchInferenceJobMode' => [ 'type' => 'string', 'enum' => [ 'BATCH_INFERENCE', 'THEME_GENERATION', ], ], 'BatchInferenceJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchInferenceJobSummary' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], ], ], 'BatchInferenceJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchInferenceJobSummary', ], 'max' => 100, ], 'BatchSegmentJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchSegmentJobInput', ], 'jobOutput' => [ 'shape' => 'BatchSegmentJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'BatchSegmentJobInput' => [ 'type' => 'structure', 'required' => [ 's3DataSource', ], 'members' => [ 's3DataSource' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchSegmentJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'BatchSegmentJobSummary' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'BatchSegmentJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchSegmentJobSummary', ], 'max' => 100, ], 'Boolean' => [ 'type' => 'boolean', ], 'Campaign' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'campaignArn' => [ 'shape' => 'Arn', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestCampaignUpdate' => [ 'shape' => 'CampaignUpdateSummary', ], ], ], 'CampaignConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], 'enableMetadataWithRecommendations' => [ 'shape' => 'Boolean', ], 'syncWithLatestSolutionVersion' => [ 'shape' => 'Boolean', ], ], ], 'CampaignSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'campaignArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'CampaignUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'Campaigns' => [ 'type' => 'list', 'member' => [ 'shape' => 'CampaignSummary', ], 'max' => 100, ], 'CategoricalHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'values' => [ 'shape' => 'CategoricalValues', ], ], ], 'CategoricalHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalHyperParameterRange', ], 'max' => 100, ], 'CategoricalValue' => [ 'type' => 'string', 'max' => 1000, ], 'CategoricalValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalValue', ], 'max' => 100, ], 'ColumnName' => [ 'type' => 'string', 'max' => 150, ], 'ColumnNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnName', ], 'max' => 50, ], 'ContinuousHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'ContinuousMinValue', ], 'maxValue' => [ 'shape' => 'ContinuousMaxValue', ], ], ], 'ContinuousHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousHyperParameterRange', ], 'max' => 100, ], 'ContinuousMaxValue' => [ 'type' => 'double', 'min' => -1000000, ], 'ContinuousMinValue' => [ 'type' => 'double', 'min' => -1000000, ], 'CreateBatchInferenceJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'solutionVersionArn', 'jobInput', 'jobOutput', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchInferenceJobInput', ], 'jobOutput' => [ 'shape' => 'BatchInferenceJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'batchInferenceJobConfig' => [ 'shape' => 'BatchInferenceJobConfig', ], 'tags' => [ 'shape' => 'Tags', ], 'batchInferenceJobMode' => [ 'shape' => 'BatchInferenceJobMode', ], 'themeGenerationConfig' => [ 'shape' => 'ThemeGenerationConfig', ], ], ], 'CreateBatchInferenceJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateBatchSegmentJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'solutionVersionArn', 'jobInput', 'jobOutput', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'filterArn' => [ 'shape' => 'Arn', ], 'numResults' => [ 'shape' => 'NumBatchResults', ], 'jobInput' => [ 'shape' => 'BatchSegmentJobInput', ], 'jobOutput' => [ 'shape' => 'BatchSegmentJobOutput', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateBatchSegmentJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'solutionVersionArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDataDeletionJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetGroupArn', 'dataSource', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDataDeletionJobResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetArn', 'roleArn', 'jobOutput', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'ingestionMode' => [ 'shape' => 'IngestionMode', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'jobOutput' => [ 'shape' => 'DatasetExportJobOutput', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'domain' => [ 'shape' => 'Domain', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'CreateDatasetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'jobName', 'datasetArn', 'dataSource', 'roleArn', ], 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'tags' => [ 'shape' => 'Tags', ], 'importMode' => [ 'shape' => 'ImportMode', ], 'publishAttributionMetricsToS3' => [ 'shape' => 'Boolean', ], ], ], 'CreateDatasetImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], ], ], 'CreateDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'schemaArn', 'datasetGroupArn', 'datasetType', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'CreateEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateEventTrackerResponse' => [ 'type' => 'structure', 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'trackingId' => [ 'shape' => 'TrackingId', ], ], ], 'CreateFilterRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'filterExpression', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'filterExpression' => [ 'shape' => 'FilterExpression', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateFilterResponse' => [ 'type' => 'structure', 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'CreateMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'metrics', 'metricsOutputConfig', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'metrics' => [ 'shape' => 'MetricAttributes', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], ], ], 'CreateMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'CreateRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', 'recipeArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'schema', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schema' => [ 'shape' => 'AvroSchema', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'CreateSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'datasetGroupArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'performHPO' => [ 'shape' => 'Boolean', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateSolutionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'CreateSolutionVersionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateSolutionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'DataDeletionJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'status' => [ 'shape' => 'Status', ], 'numDeleted' => [ 'shape' => 'Integer', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DataDeletionJobSummary' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DataDeletionJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataDeletionJobSummary', ], 'max' => 100, ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'dataLocation' => [ 'shape' => 'S3Location', ], ], ], 'Dataset' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestDatasetUpdate' => [ 'shape' => 'DatasetUpdateSummary', ], 'trackingId' => [ 'shape' => 'TrackingId', ], ], ], 'DatasetExportJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetExportJobArn' => [ 'shape' => 'Arn', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'ingestionMode' => [ 'shape' => 'IngestionMode', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'jobOutput' => [ 'shape' => 'DatasetExportJobOutput', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DatasetExportJobOutput' => [ 'type' => 'structure', 'required' => [ 's3DataDestination', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], ], ], 'DatasetExportJobSummary' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DatasetExportJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetExportJobSummary', ], 'max' => 100, ], 'DatasetGroup' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'roleArn' => [ 'shape' => 'RoleArn', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetGroupSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetGroupSummary', ], 'max' => 100, ], 'DatasetImportJob' => [ 'type' => 'structure', 'members' => [ 'jobName' => [ 'shape' => 'Name', ], 'datasetImportJobArn' => [ 'shape' => 'Arn', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'roleArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'importMode' => [ 'shape' => 'ImportMode', ], 'publishAttributionMetricsToS3' => [ 'shape' => 'Boolean', ], ], ], 'DatasetImportJobSummary' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], 'jobName' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'importMode' => [ 'shape' => 'ImportMode', ], ], ], 'DatasetImportJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetImportJobSummary', ], 'max' => 100, ], 'DatasetSchema' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'schema' => [ 'shape' => 'AvroSchema', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetSchemaSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'schemaArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'DatasetSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'datasetArn' => [ 'shape' => 'Arn', ], 'datasetType' => [ 'shape' => 'DatasetType', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'DatasetType' => [ 'type' => 'string', 'max' => 256, ], 'DatasetUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'Datasets' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetSummary', ], 'max' => 100, ], 'Date' => [ 'type' => 'timestamp', ], 'DefaultCategoricalHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'values' => [ 'shape' => 'CategoricalValues', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultCategoricalHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultCategoricalHyperParameterRange', ], 'max' => 100, ], 'DefaultContinuousHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'ContinuousMinValue', ], 'maxValue' => [ 'shape' => 'ContinuousMaxValue', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultContinuousHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultContinuousHyperParameterRange', ], 'max' => 100, ], 'DefaultHyperParameterRanges' => [ 'type' => 'structure', 'members' => [ 'integerHyperParameterRanges' => [ 'shape' => 'DefaultIntegerHyperParameterRanges', ], 'continuousHyperParameterRanges' => [ 'shape' => 'DefaultContinuousHyperParameterRanges', ], 'categoricalHyperParameterRanges' => [ 'shape' => 'DefaultCategoricalHyperParameterRanges', ], ], ], 'DefaultIntegerHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'IntegerMinValue', ], 'maxValue' => [ 'shape' => 'IntegerMaxValue', ], 'isTunable' => [ 'shape' => 'Tunable', ], ], ], 'DefaultIntegerHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultIntegerHyperParameterRange', ], 'max' => 100, ], 'DeleteCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'datasetGroupArn', ], 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'eventTrackerArn', ], 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteFilterRequest' => [ 'type' => 'structure', 'required' => [ 'filterArn', ], 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'metricAttributionArn', ], 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'schemaArn', ], 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAlgorithmRequest' => [ 'type' => 'structure', 'required' => [ 'algorithmArn', ], 'members' => [ 'algorithmArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeAlgorithmResponse' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'Algorithm', ], ], ], 'DescribeBatchInferenceJobRequest' => [ 'type' => 'structure', 'required' => [ 'batchInferenceJobArn', ], 'members' => [ 'batchInferenceJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeBatchInferenceJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJob' => [ 'shape' => 'BatchInferenceJob', ], ], ], 'DescribeBatchSegmentJobRequest' => [ 'type' => 'structure', 'required' => [ 'batchSegmentJobArn', ], 'members' => [ 'batchSegmentJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeBatchSegmentJobResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJob' => [ 'shape' => 'BatchSegmentJob', ], ], ], 'DescribeCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaign' => [ 'shape' => 'Campaign', ], ], ], 'DescribeDataDeletionJobRequest' => [ 'type' => 'structure', 'required' => [ 'dataDeletionJobArn', ], 'members' => [ 'dataDeletionJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDataDeletionJobResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJob' => [ 'shape' => 'DataDeletionJob', ], ], ], 'DescribeDatasetExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'datasetExportJobArn', ], 'members' => [ 'datasetExportJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJob' => [ 'shape' => 'DatasetExportJob', ], ], ], 'DescribeDatasetGroupRequest' => [ 'type' => 'structure', 'required' => [ 'datasetGroupArn', ], 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroup' => [ 'shape' => 'DatasetGroup', ], ], ], 'DescribeDatasetImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'datasetImportJobArn', ], 'members' => [ 'datasetImportJobArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJob' => [ 'shape' => 'DatasetImportJob', ], ], ], 'DescribeDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'dataset' => [ 'shape' => 'Dataset', ], ], ], 'DescribeEventTrackerRequest' => [ 'type' => 'structure', 'required' => [ 'eventTrackerArn', ], 'members' => [ 'eventTrackerArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeEventTrackerResponse' => [ 'type' => 'structure', 'members' => [ 'eventTracker' => [ 'shape' => 'EventTracker', ], ], ], 'DescribeFeatureTransformationRequest' => [ 'type' => 'structure', 'required' => [ 'featureTransformationArn', ], 'members' => [ 'featureTransformationArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeFeatureTransformationResponse' => [ 'type' => 'structure', 'members' => [ 'featureTransformation' => [ 'shape' => 'FeatureTransformation', ], ], ], 'DescribeFilterRequest' => [ 'type' => 'structure', 'required' => [ 'filterArn', ], 'members' => [ 'filterArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeFilterResponse' => [ 'type' => 'structure', 'members' => [ 'filter' => [ 'shape' => 'Filter', ], ], ], 'DescribeMetricAttributionRequest' => [ 'type' => 'structure', 'required' => [ 'metricAttributionArn', ], 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttribution' => [ 'shape' => 'MetricAttribution', ], ], ], 'DescribeRecipeRequest' => [ 'type' => 'structure', 'required' => [ 'recipeArn', ], 'members' => [ 'recipeArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRecipeResponse' => [ 'type' => 'structure', 'members' => [ 'recipe' => [ 'shape' => 'Recipe', ], ], ], 'DescribeRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommender' => [ 'shape' => 'Recommender', ], ], ], 'DescribeSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'schemaArn', ], 'members' => [ 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'schema' => [ 'shape' => 'DatasetSchema', ], ], ], 'DescribeSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSolutionResponse' => [ 'type' => 'structure', 'members' => [ 'solution' => [ 'shape' => 'Solution', ], ], ], 'DescribeSolutionVersionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeSolutionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersion' => [ 'shape' => 'SolutionVersion', ], ], ], 'Description' => [ 'type' => 'string', ], 'DockerURI' => [ 'type' => 'string', 'max' => 256, ], 'Domain' => [ 'type' => 'string', 'enum' => [ 'ECOMMERCE', 'VIDEO_ON_DEMAND', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EventTracker' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'accountId' => [ 'shape' => 'AccountId', ], 'trackingId' => [ 'shape' => 'TrackingId', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'EventTrackerSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'eventTrackerArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'EventTrackers' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventTrackerSummary', ], 'max' => 100, ], 'EventType' => [ 'type' => 'string', 'max' => 256, ], 'EventValueThreshold' => [ 'type' => 'string', 'max' => 256, ], 'ExcludedDatasetColumns' => [ 'type' => 'map', 'key' => [ 'shape' => 'DatasetType', ], 'value' => [ 'shape' => 'ColumnNamesList', ], 'max' => 3, ], 'FailureReason' => [ 'type' => 'string', ], 'FeatureTransformation' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'featureTransformationArn' => [ 'shape' => 'Arn', ], 'defaultParameters' => [ 'shape' => 'FeaturizationParameters', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], ], ], 'FeatureTransformationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'FeaturizationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'FieldsForThemeGeneration' => [ 'type' => 'structure', 'required' => [ 'itemName', ], 'members' => [ 'itemName' => [ 'shape' => 'ColumnName', ], ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'filterArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'filterExpression' => [ 'shape' => 'FilterExpression', ], 'status' => [ 'shape' => 'Status', ], ], ], 'FilterExpression' => [ 'type' => 'string', 'max' => 2500, 'min' => 1, 'sensitive' => true, ], 'FilterSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'filterArn' => [ 'shape' => 'Arn', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'status' => [ 'shape' => 'Status', ], ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterSummary', ], 'max' => 100, ], 'GetSolutionMetricsRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'GetSolutionMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'metrics' => [ 'shape' => 'Metrics', ], ], ], 'HPOConfig' => [ 'type' => 'structure', 'members' => [ 'hpoObjective' => [ 'shape' => 'HPOObjective', ], 'hpoResourceConfig' => [ 'shape' => 'HPOResourceConfig', ], 'algorithmHyperParameterRanges' => [ 'shape' => 'HyperParameterRanges', ], ], ], 'HPOObjective' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'HPOObjectiveType', ], 'metricName' => [ 'shape' => 'MetricName', ], 'metricRegex' => [ 'shape' => 'MetricRegex', ], ], ], 'HPOObjectiveType' => [ 'type' => 'string', 'max' => 256, ], 'HPOResource' => [ 'type' => 'string', 'max' => 256, ], 'HPOResourceConfig' => [ 'type' => 'structure', 'members' => [ 'maxNumberOfTrainingJobs' => [ 'shape' => 'HPOResource', ], 'maxParallelTrainingJobs' => [ 'shape' => 'HPOResource', ], ], ], 'HyperParameterRanges' => [ 'type' => 'structure', 'members' => [ 'integerHyperParameterRanges' => [ 'shape' => 'IntegerHyperParameterRanges', ], 'continuousHyperParameterRanges' => [ 'shape' => 'ContinuousHyperParameterRanges', ], 'categoricalHyperParameterRanges' => [ 'shape' => 'CategoricalHyperParameterRanges', ], ], ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'ImportMode' => [ 'type' => 'string', 'enum' => [ 'FULL', 'INCREMENTAL', ], ], 'IngestionMode' => [ 'type' => 'string', 'enum' => [ 'BULK', 'PUT', 'ALL', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerHyperParameterRange' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ParameterName', ], 'minValue' => [ 'shape' => 'IntegerMinValue', ], 'maxValue' => [ 'shape' => 'IntegerMaxValue', ], ], ], 'IntegerHyperParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerHyperParameterRange', ], 'max' => 100, ], 'IntegerMaxValue' => [ 'type' => 'integer', 'max' => 1000000, ], 'IntegerMinValue' => [ 'type' => 'integer', 'min' => -1000000, ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ItemAttribute' => [ 'type' => 'string', 'max' => 150, 'min' => 1, ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws.*:kms:.*:[0-9]{12}:key/.*', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListBatchInferenceJobsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListBatchInferenceJobsResponse' => [ 'type' => 'structure', 'members' => [ 'batchInferenceJobs' => [ 'shape' => 'BatchInferenceJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBatchSegmentJobsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListBatchSegmentJobsResponse' => [ 'type' => 'structure', 'members' => [ 'batchSegmentJobs' => [ 'shape' => 'BatchSegmentJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCampaignsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListCampaignsResponse' => [ 'type' => 'structure', 'members' => [ 'campaigns' => [ 'shape' => 'Campaigns', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataDeletionJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDataDeletionJobsResponse' => [ 'type' => 'structure', 'members' => [ 'dataDeletionJobs' => [ 'shape' => 'DataDeletionJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetExportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetExportJobs' => [ 'shape' => 'DatasetExportJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetGroups' => [ 'shape' => 'DatasetGroups', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetImportJobsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'datasetImportJobs' => [ 'shape' => 'DatasetImportJobs', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDatasetsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDatasetsResponse' => [ 'type' => 'structure', 'members' => [ 'datasets' => [ 'shape' => 'Datasets', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEventTrackersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListEventTrackersResponse' => [ 'type' => 'structure', 'members' => [ 'eventTrackers' => [ 'shape' => 'EventTrackers', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFiltersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListFiltersResponse' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMetricAttributionMetricsRequest' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMetricAttributionMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'metrics' => [ 'shape' => 'MetricAttributes', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMetricAttributionsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMetricAttributionsResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributions' => [ 'shape' => 'MetricAttributions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecipesRequest' => [ 'type' => 'structure', 'members' => [ 'recipeProvider' => [ 'shape' => 'RecipeProvider', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'ListRecipesResponse' => [ 'type' => 'structure', 'members' => [ 'recipes' => [ 'shape' => 'Recipes', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRecommendersRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListRecommendersResponse' => [ 'type' => 'structure', 'members' => [ 'recommenders' => [ 'shape' => 'Recommenders', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSchemasRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSchemasResponse' => [ 'type' => 'structure', 'members' => [ 'schemas' => [ 'shape' => 'Schemas', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSolutionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSolutionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'solutionVersions' => [ 'shape' => 'SolutionVersions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSolutionsRequest' => [ 'type' => 'structure', 'members' => [ 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListSolutionsResponse' => [ 'type' => 'structure', 'members' => [ 'solutions' => [ 'shape' => 'Solutions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MetricAttribute' => [ 'type' => 'structure', 'required' => [ 'eventType', 'metricName', 'expression', ], 'members' => [ 'eventType' => [ 'shape' => 'EventType', ], 'metricName' => [ 'shape' => 'MetricName', ], 'expression' => [ 'shape' => 'MetricExpression', ], ], ], 'MetricAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricAttribute', ], 'max' => 10, ], 'MetricAttributesNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricName', ], 'max' => 10, ], 'MetricAttribution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'MetricAttributionOutput' => [ 'type' => 'structure', 'required' => [ 'roleArn', ], 'members' => [ 's3DataDestination' => [ 'shape' => 'S3DataConfig', ], 'roleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MetricAttributionSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'MetricAttributions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricAttributionSummary', ], 'max' => 100, ], 'MetricExpression' => [ 'type' => 'string', 'max' => 256, ], 'MetricName' => [ 'type' => 'string', 'max' => 256, ], 'MetricRegex' => [ 'type' => 'string', 'max' => 256, ], 'MetricValue' => [ 'type' => 'double', ], 'Metrics' => [ 'type' => 'map', 'key' => [ 'shape' => 'MetricName', ], 'value' => [ 'shape' => 'MetricValue', ], 'max' => 100, ], 'Name' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9\\-_]*', ], 'NextToken' => [ 'type' => 'string', 'max' => 1500, 'pattern' => '\\p{ASCII}{0,1500}', ], 'NumBatchResults' => [ 'type' => 'integer', ], 'ObjectiveSensitivity' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', 'OFF', ], ], 'OptimizationObjective' => [ 'type' => 'structure', 'members' => [ 'itemAttribute' => [ 'shape' => 'ItemAttribute', ], 'objectiveSensitivity' => [ 'shape' => 'ObjectiveSensitivity', ], ], ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, ], 'ParameterValue' => [ 'type' => 'string', 'max' => 1000, ], 'PerformAutoML' => [ 'type' => 'boolean', ], 'PerformAutoTraining' => [ 'type' => 'boolean', 'box' => true, ], 'PerformHPO' => [ 'type' => 'boolean', ], 'Recipe' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'algorithmArn' => [ 'shape' => 'Arn', ], 'featureTransformationArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'description' => [ 'shape' => 'Description', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'recipeType' => [ 'shape' => 'RecipeType', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'RecipeProvider' => [ 'type' => 'string', 'enum' => [ 'SERVICE', ], ], 'RecipeSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'domain' => [ 'shape' => 'Domain', ], ], ], 'RecipeType' => [ 'type' => 'string', 'max' => 256, ], 'Recipes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecipeSummary', ], 'max' => 100, ], 'Recommender' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'latestRecommenderUpdate' => [ 'shape' => 'RecommenderUpdateSummary', ], 'modelMetrics' => [ 'shape' => 'Metrics', ], ], ], 'RecommenderConfig' => [ 'type' => 'structure', 'members' => [ 'itemExplorationConfig' => [ 'shape' => 'HyperParameters', ], 'minRecommendationRequestsPerSecond' => [ 'shape' => 'TransactionsPerSecond', ], 'trainingDataConfig' => [ 'shape' => 'TrainingDataConfig', ], 'enableMetadataWithRecommendations' => [ 'shape' => 'Boolean', ], ], ], 'RecommenderSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'recommenderArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], ], ], 'RecommenderUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'Recommenders' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommenderSummary', ], 'max' => 100, ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceConfig' => [ 'type' => 'map', 'key' => [ 'shape' => 'ParameterName', ], 'value' => [ 'shape' => 'ParameterValue', ], 'max' => 100, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'RoleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+', ], 'S3DataConfig' => [ 'type' => 'structure', 'required' => [ 'path', ], 'members' => [ 'path' => [ 'shape' => 'S3Location', ], 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'S3Location' => [ 'type' => 'string', 'max' => 256, 'pattern' => '(s3|http|https)://.+', ], 'SchedulingExpression' => [ 'type' => 'string', 'max' => 16, 'min' => 1, 'pattern' => 'rate\\(\\d+ days?\\)', ], 'Schemas' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetSchemaSummary', ], 'max' => 100, ], 'Solution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'performHPO' => [ 'shape' => 'PerformHPO', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'autoMLResult' => [ 'shape' => 'AutoMLResult', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'latestSolutionVersion' => [ 'shape' => 'SolutionVersionSummary', ], 'latestSolutionUpdate' => [ 'shape' => 'SolutionUpdateSummary', ], ], ], 'SolutionConfig' => [ 'type' => 'structure', 'members' => [ 'eventValueThreshold' => [ 'shape' => 'EventValueThreshold', ], 'hpoConfig' => [ 'shape' => 'HPOConfig', ], 'algorithmHyperParameters' => [ 'shape' => 'HyperParameters', ], 'featureTransformationParameters' => [ 'shape' => 'FeatureTransformationParameters', ], 'autoMLConfig' => [ 'shape' => 'AutoMLConfig', ], 'optimizationObjective' => [ 'shape' => 'OptimizationObjective', ], 'trainingDataConfig' => [ 'shape' => 'TrainingDataConfig', ], 'autoTrainingConfig' => [ 'shape' => 'AutoTrainingConfig', ], ], ], 'SolutionSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'recipeArn' => [ 'shape' => 'Arn', ], ], ], 'SolutionUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'autoTrainingConfig' => [ 'shape' => 'AutoTrainingConfig', ], ], ], 'SolutionUpdateSummary' => [ 'type' => 'structure', 'members' => [ 'solutionUpdateConfig' => [ 'shape' => 'SolutionUpdateConfig', ], 'status' => [ 'shape' => 'Status', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'SolutionVersion' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'solutionArn' => [ 'shape' => 'Arn', ], 'performHPO' => [ 'shape' => 'PerformHPO', ], 'performAutoML' => [ 'shape' => 'PerformAutoML', ], 'recipeArn' => [ 'shape' => 'Arn', ], 'eventType' => [ 'shape' => 'EventType', ], 'datasetGroupArn' => [ 'shape' => 'Arn', ], 'solutionConfig' => [ 'shape' => 'SolutionConfig', ], 'trainingHours' => [ 'shape' => 'TrainingHours', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'tunedHPOParams' => [ 'shape' => 'TunedHPOParams', ], 'status' => [ 'shape' => 'Status', ], 'failureReason' => [ 'shape' => 'FailureReason', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'trainingType' => [ 'shape' => 'TrainingType', ], ], ], 'SolutionVersionSummary' => [ 'type' => 'structure', 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'Status', ], 'trainingMode' => [ 'shape' => 'TrainingMode', ], 'trainingType' => [ 'shape' => 'TrainingType', ], 'creationDateTime' => [ 'shape' => 'Date', ], 'lastUpdatedDateTime' => [ 'shape' => 'Date', ], 'failureReason' => [ 'shape' => 'FailureReason', ], ], ], 'SolutionVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SolutionVersionSummary', ], 'max' => 100, ], 'Solutions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SolutionSummary', ], 'max' => 100, ], 'StartRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StartRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'Status' => [ 'type' => 'string', 'max' => 256, ], 'StopRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StopRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'StopSolutionVersionCreationRequest' => [ 'type' => 'structure', 'required' => [ 'solutionVersionArn', ], 'members' => [ 'solutionVersionArn' => [ 'shape' => 'Arn', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'tagKey', 'tagValue', ], 'members' => [ 'tagKey' => [ 'shape' => 'TagKey', ], 'tagValue' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 0, ], 'ThemeGenerationConfig' => [ 'type' => 'structure', 'required' => [ 'fieldsForThemeGeneration', ], 'members' => [ 'fieldsForThemeGeneration' => [ 'shape' => 'FieldsForThemeGeneration', ], ], ], 'TooManyTagKeysException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TrackingId' => [ 'type' => 'string', 'max' => 256, ], 'TrainingDataConfig' => [ 'type' => 'structure', 'members' => [ 'excludedDatasetColumns' => [ 'shape' => 'ExcludedDatasetColumns', ], ], ], 'TrainingHours' => [ 'type' => 'double', 'min' => 0, ], 'TrainingInputMode' => [ 'type' => 'string', 'max' => 256, ], 'TrainingMode' => [ 'type' => 'string', 'enum' => [ 'FULL', 'UPDATE', 'AUTOTRAIN', ], ], 'TrainingType' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC', 'MANUAL', ], ], 'TransactionsPerSecond' => [ 'type' => 'integer', 'min' => 1, ], 'Tunable' => [ 'type' => 'boolean', ], 'TunedHPOParams' => [ 'type' => 'structure', 'members' => [ 'algorithmHyperParameters' => [ 'shape' => 'HyperParameters', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCampaignRequest' => [ 'type' => 'structure', 'required' => [ 'campaignArn', ], 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], 'solutionVersionArn' => [ 'shape' => 'Arn', ], 'minProvisionedTPS' => [ 'shape' => 'TransactionsPerSecond', ], 'campaignConfig' => [ 'shape' => 'CampaignConfig', ], ], ], 'UpdateCampaignResponse' => [ 'type' => 'structure', 'members' => [ 'campaignArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateDatasetRequest' => [ 'type' => 'structure', 'required' => [ 'datasetArn', 'schemaArn', ], 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], 'schemaArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateDatasetResponse' => [ 'type' => 'structure', 'members' => [ 'datasetArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateMetricAttributionRequest' => [ 'type' => 'structure', 'members' => [ 'addMetrics' => [ 'shape' => 'MetricAttributes', ], 'removeMetrics' => [ 'shape' => 'MetricAttributesNamesList', ], 'metricsOutputConfig' => [ 'shape' => 'MetricAttributionOutput', ], 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateMetricAttributionResponse' => [ 'type' => 'structure', 'members' => [ 'metricAttributionArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateRecommenderRequest' => [ 'type' => 'structure', 'required' => [ 'recommenderArn', 'recommenderConfig', ], 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], 'recommenderConfig' => [ 'shape' => 'RecommenderConfig', ], ], ], 'UpdateRecommenderResponse' => [ 'type' => 'structure', 'members' => [ 'recommenderArn' => [ 'shape' => 'Arn', ], ], ], 'UpdateSolutionRequest' => [ 'type' => 'structure', 'required' => [ 'solutionArn', ], 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], 'performAutoTraining' => [ 'shape' => 'PerformAutoTraining', ], 'solutionUpdateConfig' => [ 'shape' => 'SolutionUpdateConfig', ], ], ], 'UpdateSolutionResponse' => [ 'type' => 'structure', 'members' => [ 'solutionArn' => [ 'shape' => 'Arn', ], ], ], ],]; diff --git a/src/data/personalize/2018-05-22/docs-2.json b/src/data/personalize/2018-05-22/docs-2.json index ef2d296aa9..e554615c74 100644 --- a/src/data/personalize/2018-05-22/docs-2.json +++ b/src/data/personalize/2018-05-22/docs-2.json @@ -15,7 +15,7 @@ "CreateMetricAttribution": "

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

", "CreateRecommender": "

Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.

Minimum recommendation requests per second

A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.

If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests.

Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.

Status

A recommender can be in one of the following states:

To get the recommender status, call DescribeRecommender.

Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.

Related APIs

", "CreateSchema": "

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

Related APIs

", - "CreateSolution": "

After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

", + "CreateSolution": "

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

", "CreateSolutionVersion": "

Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

", "DeleteCampaign": "

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.

", "DeleteDataset": "

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

", @@ -71,7 +71,8 @@ "UpdateCampaign": "

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

", "UpdateDataset": "

Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.

", "UpdateMetricAttribution": "

Updates a metric attribution.

", - "UpdateRecommender": "

Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

" + "UpdateRecommender": "

Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

", + "UpdateSolution": "

Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.

A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.

" }, "shapes": { "AccountId": { @@ -258,7 +259,9 @@ "UpdateMetricAttributionRequest$metricAttributionArn": "

The Amazon Resource Name (ARN) for the metric attribution to update.

", "UpdateMetricAttributionResponse$metricAttributionArn": "

The Amazon Resource Name (ARN) for the metric attribution that you updated.

", "UpdateRecommenderRequest$recommenderArn": "

The Amazon Resource Name (ARN) of the recommender to modify.

", - "UpdateRecommenderResponse$recommenderArn": "

The same recommender Amazon Resource Name (ARN) as given in the request.

" + "UpdateRecommenderResponse$recommenderArn": "

The same recommender Amazon Resource Name (ARN) as given in the request.

", + "UpdateSolutionRequest$solutionArn": "

The Amazon Resource Name (ARN) of the solution to update.

", + "UpdateSolutionResponse$solutionArn": "

The same solution Amazon Resource Name (ARN) as given in the request.

" } }, "ArnList": { @@ -282,7 +285,8 @@ "AutoTrainingConfig": { "base": "

The automatic training configuration to use when performAutoTraining is true.

", "refs": { - "SolutionConfig$autoTrainingConfig": "

Specifies the automatic training configuration to use.

" + "SolutionConfig$autoTrainingConfig": "

Specifies the automatic training configuration to use.

", + "SolutionUpdateConfig$autoTrainingConfig": null } }, "AvroSchema": { @@ -835,6 +839,8 @@ "Solution$lastUpdatedDateTime": "

The date and time (in Unix time) that the solution was last updated.

", "SolutionSummary$creationDateTime": "

The date and time (in Unix time) that the solution was created.

", "SolutionSummary$lastUpdatedDateTime": "

The date and time (in Unix time) that the solution was last updated.

", + "SolutionUpdateSummary$creationDateTime": "

The date and time (in Unix format) that the solution update was created.

", + "SolutionUpdateSummary$lastUpdatedDateTime": "

The date and time (in Unix time) that the solution update was last updated.

", "SolutionVersion$creationDateTime": "

The date and time (in Unix time) that this version of the solution was created.

", "SolutionVersion$lastUpdatedDateTime": "

The date and time (in Unix time) that the solution was last updated.

", "SolutionVersionSummary$creationDateTime": "

The date and time (in Unix time) that this version of a solution was created.

", @@ -1211,6 +1217,7 @@ "MetricAttributionSummary$failureReason": "

The metric attribution's failure reason.

", "Recommender$failureReason": "

If a recommender fails, the reason behind the failure.

", "RecommenderUpdateSummary$failureReason": "

If a recommender update fails, the reason behind the failure.

", + "SolutionUpdateSummary$failureReason": "

If a solution update fails, the reason behind the failure.

", "SolutionVersion$failureReason": "

If training a solution version fails, the reason for the failure.

", "SolutionVersionSummary$failureReason": "

If a solution version fails, the reason behind the failure.

" } @@ -1830,8 +1837,10 @@ "PerformAutoTraining": { "base": null, "refs": { - "CreateSolutionRequest$performAutoTraining": "

Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

", - "Solution$performAutoTraining": "

Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.

For more information about auto training, see Creating and configuring a solution.

" + "CreateSolutionRequest$performAutoTraining": "

Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

", + "Solution$performAutoTraining": "

Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.

For more information about auto training, see Creating and configuring a solution.

", + "SolutionUpdateSummary$performAutoTraining": "

Whether the solution automatically creates solution versions.

", + "UpdateSolutionRequest$performAutoTraining": "

Whether the solution uses automatic training to create new solution versions (trained models). You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration.

If you turn on automatic training, the first automatic training starts within one hour after the solution update completes. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information about automatic training, see Configuring automatic training.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

" } }, "PerformHPO": { @@ -1973,7 +1982,7 @@ } }, "Solution": { - "base": "

After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.

", + "base": "

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.

", "refs": { "DescribeSolutionResponse$solution": "

An object that describes the solution.

" } @@ -1981,7 +1990,7 @@ "SolutionConfig": { "base": "

Describes the configuration properties for the solution.

", "refs": { - "CreateSolutionRequest$solutionConfig": "

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

", + "CreateSolutionRequest$solutionConfig": "

The configuration properties for the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

", "Solution$solutionConfig": "

Describes the configuration properties for the solution.

", "SolutionVersion$solutionConfig": "

Describes the configuration properties for the solution.

" } @@ -1992,6 +2001,19 @@ "Solutions$member": null } }, + "SolutionUpdateConfig": { + "base": "

The configuration details of the solution update.

", + "refs": { + "SolutionUpdateSummary$solutionUpdateConfig": "

The configuration details of the solution.

", + "UpdateSolutionRequest$solutionUpdateConfig": "

The new configuration details of the solution.

" + } + }, + "SolutionUpdateSummary": { + "base": "

Provides a summary of the properties of a solution update. For a complete listing, call the DescribeSolution API.

", + "refs": { + "Solution$latestSolutionUpdate": "

Provides a summary of the latest updates to the solution.

" + } + }, "SolutionVersion": { "base": "

An object that provides information about a specific version of a Solution in a Custom dataset group.

", "refs": { @@ -2059,9 +2081,10 @@ "RecipeSummary$status": "

The status of the recipe.

", "Recommender$status": "

The status of the recommender.

A recommender can be in one of the following states:

", "RecommenderSummary$status": "

The status of the recommender. A recommender can be in one of the following states:

", - "RecommenderUpdateSummary$status": "

The status of the recommender update.

A recommender can be in one of the following states:

", + "RecommenderUpdateSummary$status": "

The status of the recommender update. A recommender update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

", "Solution$status": "

The status of the solution.

A solution can be in one of the following states:

", "SolutionSummary$status": "

The status of the solution.

A solution can be in one of the following states:

", + "SolutionUpdateSummary$status": "

The status of the solution update. A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

", "SolutionVersion$status": "

The status of the solution version.

A solution version can be in one of the following states:

", "SolutionVersionSummary$status": "

The status of the solution version.

A solution version can be in one of the following states:

" } @@ -2268,6 +2291,16 @@ "base": null, "refs": { } + }, + "UpdateSolutionRequest": { + "base": null, + "refs": { + } + }, + "UpdateSolutionResponse": { + "base": null, + "refs": { + } } } } diff --git a/src/data/personalize/2018-05-22/docs-2.json.php b/src/data/personalize/2018-05-22/docs-2.json.php index 80901656bf..5a59be987c 100644 --- a/src/data/personalize/2018-05-22/docs-2.json.php +++ b/src/data/personalize/2018-05-22/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

', 'operations' => [ 'CreateBatchInferenceJob' => '

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job\'s mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can\'t get batch recommendations with the Trending-Now or Next-Best-Action recipes.

', 'CreateBatchSegmentJob' => '

Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.

', 'CreateCampaign' => '

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There\'s a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

Status

A campaign can be in one of the following states:

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

', 'CreateDataDeletionJob' => '

Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.

After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.

Status

A data deletion job can have one of the following statuses:

To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

', 'CreateDataset' => '

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are 5 types of datasets:

Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

To get the status of the dataset, call DescribeDataset.

Related APIs

', 'CreateDatasetExportJob' => '

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

', 'CreateDatasetGroup' => '

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.

A dataset group can be in one of the following states:

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

Related APIs

', 'CreateDatasetImportJob' => '

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.

Status

A dataset import job can be in one of the following states:

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

', 'CreateEventTracker' => '

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

', 'CreateFilter' => '

Creates a recommendation filter. For more information, see Filtering recommendations and user segments.

', 'CreateMetricAttribution' => '

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

', 'CreateRecommender' => '

Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender\'s Amazon Resource Name (ARN) when you make a GetRecommendations request.

Minimum recommendation requests per second

A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

When you create a recommender, you can configure the recommender\'s minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.

If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There\'s a short time delay while the capacity is increased that might cause loss of requests.

Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.

Status

A recommender can be in one of the following states:

To get the recommender status, call DescribeRecommender.

Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.

Related APIs

', 'CreateSchema' => '

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

Related APIs

', 'CreateSolution' => '

After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can\'t stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

After training starts, you can get the solution version\'s Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

Amazon Personalize doesn\'t support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

', 'CreateSolutionVersion' => '

Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

', 'DeleteCampaign' => '

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.

', 'DeleteDataset' => '

Deletes a dataset. You can\'t delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

', 'DeleteDatasetGroup' => '

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

', 'DeleteEventTracker' => '

Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

', 'DeleteFilter' => '

Deletes a filter.

', 'DeleteMetricAttribution' => '

Deletes a metric attribution.

', 'DeleteRecommender' => '

Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.

', 'DeleteSchema' => '

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

', 'DeleteSolution' => '

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can\'t delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

', 'DescribeAlgorithm' => '

Describes the given algorithm.

', 'DescribeBatchInferenceJob' => '

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

', 'DescribeBatchSegmentJob' => '

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

', 'DescribeCampaign' => '

Describes the given campaign, including its status.

A campaign can be in one of the following states:

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

', 'DescribeDataDeletionJob' => '

Describes the data deletion job created by CreateDataDeletionJob, including the job status.

', 'DescribeDataset' => '

Describes the given dataset. For more information on datasets, see CreateDataset.

', 'DescribeDatasetExportJob' => '

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

', 'DescribeDatasetGroup' => '

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

', 'DescribeDatasetImportJob' => '

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

', 'DescribeEventTracker' => '

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

', 'DescribeFeatureTransformation' => '

Describes the given feature transformation.

', 'DescribeFilter' => '

Describes a filter\'s properties.

', 'DescribeMetricAttribution' => '

Describes a metric attribution.

', 'DescribeRecipe' => '

Describes a recipe.

A recipe contains three items:

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

', 'DescribeRecommender' => '

Describes the given recommender, including its status.

A recommender can be in one of the following states:

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

', 'DescribeSchema' => '

Describes a schema. For more information on schemas, see CreateSchema.

', 'DescribeSolution' => '

Describes a solution. For more information on solutions, see CreateSolution.

', 'DescribeSolutionVersion' => '

Describes a specific version of a solution. For more information on solutions, see CreateSolution

', 'GetSolutionMetrics' => '

Gets the metrics for the specified solution version.

', 'ListBatchInferenceJobs' => '

Gets a list of the batch inference jobs that have been performed off of a solution version.

', 'ListBatchSegmentJobs' => '

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

', 'ListCampaigns' => '

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

', 'ListDataDeletionJobs' => '

Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.

', 'ListDatasetExportJobs' => '

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

', 'ListDatasetGroups' => '

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

', 'ListDatasetImportJobs' => '

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

', 'ListDatasets' => '

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

', 'ListEventTrackers' => '

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

', 'ListFilters' => '

Lists all filters that belong to a given dataset group.

', 'ListMetricAttributionMetrics' => '

Lists the metrics for the metric attribution.

', 'ListMetricAttributions' => '

Lists metric attributions.

', 'ListRecipes' => '

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe\'s Amazon Resource Name (ARN).

', 'ListRecommenders' => '

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.

', 'ListSchemas' => '

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

', 'ListSolutionVersions' => '

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).

', 'ListSolutions' => '

Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

', 'ListTagsForResource' => '

Get a list of tags attached to a resource.

', 'StartRecommender' => '

Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.

', 'StopRecommender' => '

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

', 'StopSolutionVersionCreation' => '

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

', 'TagResource' => '

Add a list of tags to a resource.

', 'UntagResource' => '

Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.

', 'UpdateCampaign' => '

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign\'s minProvisionedTPS, or modify your campaign\'s configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

', 'UpdateDataset' => '

Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset\'s schema.

', 'UpdateMetricAttribution' => '

Updates a metric attribution.

', 'UpdateRecommender' => '

Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

', ], 'shapes' => [ 'AccountId' => [ 'base' => NULL, 'refs' => [ 'EventTracker$accountId' => '

The Amazon Web Services account that owns the event tracker.

', ], ], 'Algorithm' => [ 'base' => '

Describes a custom algorithm.

', 'refs' => [ 'DescribeAlgorithmResponse$algorithm' => '

A listing of the properties of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => '

Describes an algorithm image.

', 'refs' => [ 'Algorithm$algorithmImage' => '

The URI of the Docker container for the algorithm image.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Algorithm$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'Algorithm$roleArn' => '

The Amazon Resource Name (ARN) of the role.

', 'ArnList$member' => NULL, 'AutoMLResult$bestRecipeArn' => '

The Amazon Resource Name (ARN) of the best recipe.

', 'BatchInferenceJob$batchInferenceJobArn' => '

The Amazon Resource Name (ARN) of the batch inference job.

', 'BatchInferenceJob$filterArn' => '

The ARN of the filter used on the batch inference job.

', 'BatchInferenceJob$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

', 'BatchInferenceJobSummary$batchInferenceJobArn' => '

The Amazon Resource Name (ARN) of the batch inference job.

', 'BatchInferenceJobSummary$solutionVersionArn' => '

The ARN of the solution version used by the batch inference job.

', 'BatchSegmentJob$batchSegmentJobArn' => '

The Amazon Resource Name (ARN) of the batch segment job.

', 'BatchSegmentJob$filterArn' => '

The ARN of the filter used on the batch segment job.

', 'BatchSegmentJob$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

', 'BatchSegmentJobSummary$batchSegmentJobArn' => '

The Amazon Resource Name (ARN) of the batch segment job.

', 'BatchSegmentJobSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

', 'Campaign$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'Campaign$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version the campaign uses.

', 'CampaignSummary$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'CampaignUpdateSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the deployed solution version.

', 'CreateBatchInferenceJobRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

', 'CreateBatchInferenceJobRequest$filterArn' => '

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

', 'CreateBatchInferenceJobResponse$batchInferenceJobArn' => '

The ARN of the batch inference job.

', 'CreateBatchSegmentJobRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

', 'CreateBatchSegmentJobRequest$filterArn' => '

The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

', 'CreateBatchSegmentJobResponse$batchSegmentJobArn' => '

The ARN of the batch segment job.

', 'CreateCampaignRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn\'t the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'CreateCampaignResponse$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'CreateDataDeletionJobRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.

', 'CreateDataDeletionJobResponse$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'CreateDatasetExportJobRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

', 'CreateDatasetExportJobResponse$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'CreateDatasetGroupResponse$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the new dataset group.

', 'CreateDatasetImportJobRequest$datasetArn' => '

The ARN of the dataset that receives the imported data.

', 'CreateDatasetImportJobResponse$datasetImportJobArn' => '

The ARN of the dataset import job.

', 'CreateDatasetRequest$schemaArn' => '

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

', 'CreateDatasetRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

', 'CreateDatasetResponse$datasetArn' => '

The ARN of the dataset.

', 'CreateEventTrackerRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

', 'CreateEventTrackerResponse$eventTrackerArn' => '

The ARN of the event tracker.

', 'CreateFilterRequest$datasetGroupArn' => '

The ARN of the dataset group that the filter will belong to.

', 'CreateFilterResponse$filterArn' => '

The ARN of the new filter.

', 'CreateMetricAttributionRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

', 'CreateMetricAttributionResponse$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the new metric attribution.

', 'CreateRecommenderRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

', 'CreateRecommenderRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

', 'CreateRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'CreateSchemaResponse$schemaArn' => '

The Amazon Resource Name (ARN) of the created schema.

', 'CreateSolutionRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

', 'CreateSolutionRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

', 'CreateSolutionResponse$solutionArn' => '

The ARN of the solution.

', 'CreateSolutionVersionRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

', 'CreateSolutionVersionResponse$solutionVersionArn' => '

The ARN of the new solution version.

', 'DataDeletionJob$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DataDeletionJob$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

', 'DataDeletionJobSummary$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DataDeletionJobSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group the job deleted records from.

', 'Dataset$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

', 'Dataset$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'Dataset$schemaArn' => '

The ARN of the associated schema.

', 'DatasetExportJob$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'DatasetExportJob$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to export.

', 'DatasetExportJob$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

', 'DatasetExportJobSummary$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'DatasetGroup$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'DatasetGroupSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'DatasetImportJob$datasetImportJobArn' => '

The ARN of the dataset import job.

', 'DatasetImportJob$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

', 'DatasetImportJob$roleArn' => '

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DatasetImportJobSummary$datasetImportJobArn' => '

The Amazon Resource Name (ARN) of the dataset import job.

', 'DatasetSchema$schemaArn' => '

The Amazon Resource Name (ARN) of the schema.

', 'DatasetSchemaSummary$schemaArn' => '

The Amazon Resource Name (ARN) of the schema.

', 'DatasetSummary$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DatasetUpdateSummary$schemaArn' => '

The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

', 'DeleteCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign to delete.

', 'DeleteDatasetGroupRequest$datasetGroupArn' => '

The ARN of the dataset group to delete.

', 'DeleteDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to delete.

', 'DeleteEventTrackerRequest$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker to delete.

', 'DeleteFilterRequest$filterArn' => '

The ARN of the filter to delete.

', 'DeleteMetricAttributionRequest$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'DeleteRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to delete.

', 'DeleteSchemaRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the schema to delete.

', 'DeleteSolutionRequest$solutionArn' => '

The ARN of the solution to delete.

', 'DescribeAlgorithmRequest$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm to describe.

', 'DescribeBatchInferenceJobRequest$batchInferenceJobArn' => '

The ARN of the batch inference job to describe.

', 'DescribeBatchSegmentJobRequest$batchSegmentJobArn' => '

The ARN of the batch segment job to describe.

', 'DescribeCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'DescribeDataDeletionJobRequest$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DescribeDatasetExportJobRequest$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job to describe.

', 'DescribeDatasetGroupRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to describe.

', 'DescribeDatasetImportJobRequest$datasetImportJobArn' => '

The Amazon Resource Name (ARN) of the dataset import job to describe.

', 'DescribeDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to describe.

', 'DescribeEventTrackerRequest$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker to describe.

', 'DescribeFeatureTransformationRequest$featureTransformationArn' => '

The Amazon Resource Name (ARN) of the feature transformation to describe.

', 'DescribeFilterRequest$filterArn' => '

The ARN of the filter to describe.

', 'DescribeMetricAttributionRequest$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'DescribeRecipeRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe to describe.

', 'DescribeRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to describe.

', 'DescribeSchemaRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the schema to retrieve.

', 'DescribeSolutionRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution to describe.

', 'DescribeSolutionVersionRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version.

', 'EventTracker$eventTrackerArn' => '

The ARN of the event tracker.

', 'EventTracker$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

', 'EventTrackerSummary$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker.

', 'FeatureTransformation$featureTransformationArn' => '

The Amazon Resource Name (ARN) of the FeatureTransformation object.

', 'Filter$filterArn' => '

The ARN of the filter.

', 'Filter$datasetGroupArn' => '

The ARN of the dataset group to which the filter belongs.

', 'FilterSummary$filterArn' => '

The ARN of the filter.

', 'FilterSummary$datasetGroupArn' => '

The ARN of the dataset group to which the filter belongs.

', 'GetSolutionMetricsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

', 'GetSolutionMetricsResponse$solutionVersionArn' => '

The same solution version ARN as specified in the request.

', 'ListBatchInferenceJobsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

', 'ListBatchSegmentJobsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

', 'ListCampaignsRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

', 'ListDataDeletionJobsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.

', 'ListDatasetExportJobsRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.

', 'ListDatasetImportJobsRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

', 'ListDatasetsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

', 'ListEventTrackersRequest$datasetGroupArn' => '

The ARN of a dataset group used to filter the response.

', 'ListFiltersRequest$datasetGroupArn' => '

The ARN of the dataset group that contains the filters.

', 'ListMetricAttributionMetricsRequest$metricAttributionArn' => '

The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.

', 'ListMetricAttributionsRequest$datasetGroupArn' => '

The metric attributions\' dataset group Amazon Resource Name (ARN).

', 'ListRecommendersRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

', 'ListSolutionVersionsRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution.

', 'ListSolutionsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'ListTagsForResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'MetricAttribution$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'MetricAttribution$datasetGroupArn' => '

The metric attribution\'s dataset group Amazon Resource Name (ARN).

', 'MetricAttributionSummary$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'Recipe$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe.

', 'Recipe$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

', 'Recipe$featureTransformationArn' => '

The ARN of the FeatureTransformation object.

', 'RecipeSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe.

', 'Recommender$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'Recommender$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

', 'Recommender$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

', 'RecommenderSummary$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'RecommenderSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

', 'RecommenderSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

', 'Solution$solutionArn' => '

The ARN of the solution.

', 'Solution$recipeArn' => '

The ARN of the recipe used to create the solution. This is required when performAutoML is false.

', 'Solution$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

', 'SolutionSummary$solutionArn' => '

The Amazon Resource Name (ARN) of the solution.

', 'SolutionSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe used by the solution.

', 'SolutionVersion$solutionVersionArn' => '

The ARN of the solution version.

', 'SolutionVersion$solutionArn' => '

The ARN of the solution.

', 'SolutionVersion$recipeArn' => '

The ARN of the recipe used in the solution.

', 'SolutionVersion$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group providing the training data.

', 'SolutionVersionSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version.

', 'StartRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to start.

', 'StartRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender you started.

', 'StopRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to stop.

', 'StopRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender you stopped.

', 'StopSolutionVersionCreationRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version you want to stop creating.

', 'TagResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'UntagResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'UpdateCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'UpdateCampaignRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn\'t the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'UpdateCampaignResponse$campaignArn' => '

The same campaign ARN as given in the request.

', 'UpdateDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that you want to update.

', 'UpdateDatasetRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the new schema you want use.

', 'UpdateDatasetResponse$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset you updated.

', 'UpdateMetricAttributionRequest$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the metric attribution to update.

', 'UpdateMetricAttributionResponse$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the metric attribution that you updated.

', 'UpdateRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to modify.

', 'UpdateRecommenderResponse$recommenderArn' => '

The same recommender Amazon Resource Name (ARN) as given in the request.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'AutoMLConfig$recipeList' => '

The list of candidate recipes.

', ], ], 'AutoMLConfig' => [ 'base' => '

When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.

', 'refs' => [ 'SolutionConfig$autoMLConfig' => '

The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

', ], ], 'AutoMLResult' => [ 'base' => '

When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.

', 'refs' => [ 'Solution$autoMLResult' => '

When performAutoML is true, specifies the best recipe found.

', ], ], 'AutoTrainingConfig' => [ 'base' => '

The automatic training configuration to use when performAutoTraining is true.

', 'refs' => [ 'SolutionConfig$autoTrainingConfig' => '

Specifies the automatic training configuration to use.

', ], ], 'AvroSchema' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaRequest$schema' => '

A schema in Avro JSON format.

', 'DatasetSchema$schema' => '

The schema.

', ], ], 'BatchInferenceJob' => [ 'base' => '

Contains information on a batch inference job.

', 'refs' => [ 'DescribeBatchInferenceJobResponse$batchInferenceJob' => '

Information on the specified batch inference job.

', ], ], 'BatchInferenceJobConfig' => [ 'base' => '

The configuration details of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$batchInferenceJobConfig' => '

A string to string map of the configuration details of a batch inference job.

', 'CreateBatchInferenceJobRequest$batchInferenceJobConfig' => '

The configuration details of a batch inference job.

', ], ], 'BatchInferenceJobInput' => [ 'base' => '

The input configuration of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$jobInput' => '

The Amazon S3 path that leads to the input data used to generate the batch inference job.

', 'CreateBatchInferenceJobRequest$jobInput' => '

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

', ], ], 'BatchInferenceJobMode' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$batchInferenceJobMode' => '

The job\'s mode.

', 'BatchInferenceJobSummary$batchInferenceJobMode' => '

The job\'s mode.

', 'CreateBatchInferenceJobRequest$batchInferenceJobMode' => '

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don\'t want to generate themes, use the default BATCH_INFERENCE.

When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

', ], ], 'BatchInferenceJobOutput' => [ 'base' => '

The output configuration parameters of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$jobOutput' => '

The Amazon S3 bucket that contains the output data generated by the batch inference job.

', 'CreateBatchInferenceJobRequest$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output will be stored.

', ], ], 'BatchInferenceJobSummary' => [ 'base' => '

A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

', 'refs' => [ 'BatchInferenceJobs$member' => NULL, ], ], 'BatchInferenceJobs' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsResponse$batchInferenceJobs' => '

A list containing information on each job that is returned.

', ], ], 'BatchSegmentJob' => [ 'base' => '

Contains information on a batch segment job.

', 'refs' => [ 'DescribeBatchSegmentJobResponse$batchSegmentJob' => '

Information on the specified batch segment job.

', ], ], 'BatchSegmentJobInput' => [ 'base' => '

The input configuration of a batch segment job.

', 'refs' => [ 'BatchSegmentJob$jobInput' => '

The Amazon S3 path that leads to the input data used to generate the batch segment job.

', 'CreateBatchSegmentJobRequest$jobInput' => '

The Amazon S3 path for the input data used to generate the batch segment job.

', ], ], 'BatchSegmentJobOutput' => [ 'base' => '

The output configuration parameters of a batch segment job.

', 'refs' => [ 'BatchSegmentJob$jobOutput' => '

The Amazon S3 bucket that contains the output data generated by the batch segment job.

', 'CreateBatchSegmentJobRequest$jobOutput' => '

The Amazon S3 path for the bucket where the job\'s output will be stored.

', ], ], 'BatchSegmentJobSummary' => [ 'base' => '

A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.

', 'refs' => [ 'BatchSegmentJobs$member' => NULL, ], ], 'BatchSegmentJobs' => [ 'base' => NULL, 'refs' => [ 'ListBatchSegmentJobsResponse$batchSegmentJobs' => '

A list containing information on each job that is returned.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CampaignConfig$enableMetadataWithRecommendations' => '

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

', 'CampaignConfig$syncWithLatestSolutionVersion' => '

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'CreateDatasetImportJobRequest$publishAttributionMetricsToS3' => '

If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

', 'CreateSolutionRequest$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

', 'DatasetImportJob$publishAttributionMetricsToS3' => '

Whether the job publishes metrics to Amazon S3 for a metric attribution.

', 'RecommenderConfig$enableMetadataWithRecommendations' => '

Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

', ], ], 'Campaign' => [ 'base' => '

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

', 'refs' => [ 'DescribeCampaignResponse$campaign' => '

The properties of the campaign.

', ], ], 'CampaignConfig' => [ 'base' => '

The configuration details of a campaign.

', 'refs' => [ 'Campaign$campaignConfig' => '

The configuration details of a campaign.

', 'CampaignUpdateSummary$campaignConfig' => NULL, 'CreateCampaignRequest$campaignConfig' => '

The configuration details of a campaign.

', 'UpdateCampaignRequest$campaignConfig' => '

The configuration details of a campaign.

', ], ], 'CampaignSummary' => [ 'base' => '

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

', 'refs' => [ 'Campaigns$member' => NULL, ], ], 'CampaignUpdateSummary' => [ 'base' => '

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

', 'refs' => [ 'Campaign$latestCampaignUpdate' => NULL, ], ], 'Campaigns' => [ 'base' => NULL, 'refs' => [ 'ListCampaignsResponse$campaigns' => '

A list of the campaigns.

', ], ], 'CategoricalHyperParameterRange' => [ 'base' => '

Provides the name and range of a categorical hyperparameter.

', 'refs' => [ 'CategoricalHyperParameterRanges$member' => NULL, ], ], 'CategoricalHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$categoricalHyperParameterRanges' => '

The categorical hyperparameters and their ranges.

', ], ], 'CategoricalValue' => [ 'base' => NULL, 'refs' => [ 'CategoricalValues$member' => NULL, ], ], 'CategoricalValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalHyperParameterRange$values' => '

A list of the categories for the hyperparameter.

', 'DefaultCategoricalHyperParameterRange$values' => '

A list of the categories for the hyperparameter.

', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'ColumnNamesList$member' => NULL, 'FieldsForThemeGeneration$itemName' => '

The name of the Items dataset column that stores the name of each item in the dataset.

', ], ], 'ColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'ExcludedDatasetColumns$value' => NULL, ], ], 'ContinuousHyperParameterRange' => [ 'base' => '

Provides the name and range of a continuous hyperparameter.

', 'refs' => [ 'ContinuousHyperParameterRanges$member' => NULL, ], ], 'ContinuousHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$continuousHyperParameterRanges' => '

The continuous hyperparameters and their ranges.

', ], ], 'ContinuousMaxValue' => [ 'base' => NULL, 'refs' => [ 'ContinuousHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', 'DefaultContinuousHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', ], ], 'ContinuousMinValue' => [ 'base' => NULL, 'refs' => [ 'ContinuousHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', 'DefaultContinuousHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', ], ], 'CreateBatchInferenceJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchInferenceJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchSegmentJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchSegmentJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataDeletionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataDeletionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventTrackerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFilterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DataDeletionJob' => [ 'base' => '

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

', 'refs' => [ 'DescribeDataDeletionJobResponse$dataDeletionJob' => '

Information about the data deletion job, including the status.

The status is one of the following values:

', ], ], 'DataDeletionJobSummary' => [ 'base' => '

Provides a summary of the properties of a data deletion job. For a complete listing, call the DescribeDataDeletionJob API operation.

', 'refs' => [ 'DataDeletionJobs$member' => NULL, ], ], 'DataDeletionJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataDeletionJobsResponse$dataDeletionJobs' => '

The list of data deletion jobs.

', ], ], 'DataSource' => [ 'base' => '

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

', 'refs' => [ 'CreateDataDeletionJobRequest$dataSource' => '

The Amazon S3 bucket that contains the list of userIds of the users to delete.

', 'CreateDatasetImportJobRequest$dataSource' => '

The Amazon S3 bucket that contains the training data to import.

', 'DataDeletionJob$dataSource' => NULL, 'DatasetImportJob$dataSource' => '

The Amazon S3 bucket that contains the training data to import.

', ], ], 'Dataset' => [ 'base' => '

Provides metadata for a dataset.

', 'refs' => [ 'DescribeDatasetResponse$dataset' => '

A listing of the dataset\'s properties.

', ], ], 'DatasetExportJob' => [ 'base' => '

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

A dataset export job can be in one of the following states:

', 'refs' => [ 'DescribeDatasetExportJobResponse$datasetExportJob' => '

Information about the dataset export job, including the status.

The status is one of the following values:

', ], ], 'DatasetExportJobOutput' => [ 'base' => '

The output configuration parameters of a dataset export job.

', 'refs' => [ 'CreateDatasetExportJobRequest$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output is stored.

', 'DatasetExportJob$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output is stored. For example:

s3://bucket-name/folder-name/

', ], ], 'DatasetExportJobSummary' => [ 'base' => '

Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.

', 'refs' => [ 'DatasetExportJobs$member' => NULL, ], ], 'DatasetExportJobs' => [ 'base' => NULL, 'refs' => [ 'ListDatasetExportJobsResponse$datasetExportJobs' => '

The list of dataset export jobs.

', ], ], 'DatasetGroup' => [ 'base' => '

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.

', 'refs' => [ 'DescribeDatasetGroupResponse$datasetGroup' => '

A listing of the dataset group\'s properties.

', ], ], 'DatasetGroupSummary' => [ 'base' => '

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

', 'refs' => [ 'DatasetGroups$member' => NULL, ], ], 'DatasetGroups' => [ 'base' => NULL, 'refs' => [ 'ListDatasetGroupsResponse$datasetGroups' => '

The list of your dataset groups.

', ], ], 'DatasetImportJob' => [ 'base' => '

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset import job can be in one of the following states:

', 'refs' => [ 'DescribeDatasetImportJobResponse$datasetImportJob' => '

Information about the dataset import job, including the status.

The status is one of the following values:

', ], ], 'DatasetImportJobSummary' => [ 'base' => '

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

', 'refs' => [ 'DatasetImportJobs$member' => NULL, ], ], 'DatasetImportJobs' => [ 'base' => NULL, 'refs' => [ 'ListDatasetImportJobsResponse$datasetImportJobs' => '

The list of dataset import jobs.

', ], ], 'DatasetSchema' => [ 'base' => '

Describes the schema for a dataset. For more information on schemas, see CreateSchema.

', 'refs' => [ 'DescribeSchemaResponse$schema' => '

The requested schema.

', ], ], 'DatasetSchemaSummary' => [ 'base' => '

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

', 'refs' => [ 'Schemas$member' => NULL, ], ], 'DatasetSummary' => [ 'base' => '

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

', 'refs' => [ 'Datasets$member' => NULL, ], ], 'DatasetType' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetRequest$datasetType' => '

The type of dataset.

One of the following (case insensitive) values:

', 'Dataset$datasetType' => '

One of the following values:

', 'DatasetSummary$datasetType' => '

The dataset type. One of the following values:

', 'ExcludedDatasetColumns$key' => NULL, ], ], 'DatasetUpdateSummary' => [ 'base' => '

Describes an update to a dataset.

', 'refs' => [ 'Dataset$latestDatasetUpdate' => '

Describes the latest update to the dataset.

', ], ], 'Datasets' => [ 'base' => NULL, 'refs' => [ 'ListDatasetsResponse$datasets' => '

An array of Dataset objects. Each object provides metadata information.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'Algorithm$creationDateTime' => '

The date and time (in Unix time) that the algorithm was created.

', 'Algorithm$lastUpdatedDateTime' => '

The date and time (in Unix time) that the algorithm was last updated.

', 'BatchInferenceJob$creationDateTime' => '

The time at which the batch inference job was created.

', 'BatchInferenceJob$lastUpdatedDateTime' => '

The time at which the batch inference job was last updated.

', 'BatchInferenceJobSummary$creationDateTime' => '

The time at which the batch inference job was created.

', 'BatchInferenceJobSummary$lastUpdatedDateTime' => '

The time at which the batch inference job was last updated.

', 'BatchSegmentJob$creationDateTime' => '

The time at which the batch segment job was created.

', 'BatchSegmentJob$lastUpdatedDateTime' => '

The time at which the batch segment job last updated.

', 'BatchSegmentJobSummary$creationDateTime' => '

The time at which the batch segment job was created.

', 'BatchSegmentJobSummary$lastUpdatedDateTime' => '

The time at which the batch segment job was last updated.

', 'Campaign$creationDateTime' => '

The date and time (in Unix format) that the campaign was created.

', 'Campaign$lastUpdatedDateTime' => '

The date and time (in Unix format) that the campaign was last updated.

', 'CampaignSummary$creationDateTime' => '

The date and time (in Unix time) that the campaign was created.

', 'CampaignSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the campaign was last updated.

', 'CampaignUpdateSummary$creationDateTime' => '

The date and time (in Unix time) that the campaign update was created.

', 'CampaignUpdateSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the campaign update was last updated.

', 'DataDeletionJob$creationDateTime' => '

The creation date and time (in Unix time) of the data deletion job.

', 'DataDeletionJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the data deletion job was last updated.

', 'DataDeletionJobSummary$creationDateTime' => '

The creation date and time (in Unix time) of the data deletion job.

', 'DataDeletionJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) the data deletion job was last updated.

', 'Dataset$creationDateTime' => '

The creation date and time (in Unix time) of the dataset.

', 'Dataset$lastUpdatedDateTime' => '

A time stamp that shows when the dataset was updated.

', 'DatasetExportJob$creationDateTime' => '

The creation date and time (in Unix time) of the dataset export job.

', 'DatasetExportJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the status of the dataset export job was last updated.

', 'DatasetExportJobSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset export job was created.

', 'DatasetExportJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset export job status was last updated.

', 'DatasetGroup$creationDateTime' => '

The creation date and time (in Unix time) of the dataset group.

', 'DatasetGroup$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the dataset group.

', 'DatasetGroupSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset group was created.

', 'DatasetGroupSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset group was last updated.

', 'DatasetImportJob$creationDateTime' => '

The creation date and time (in Unix time) of the dataset import job.

', 'DatasetImportJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the dataset was last updated.

', 'DatasetImportJobSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset import job was created.

', 'DatasetImportJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset import job status was last updated.

', 'DatasetSchema$creationDateTime' => '

The date and time (in Unix time) that the schema was created.

', 'DatasetSchema$lastUpdatedDateTime' => '

The date and time (in Unix time) that the schema was last updated.

', 'DatasetSchemaSummary$creationDateTime' => '

The date and time (in Unix time) that the schema was created.

', 'DatasetSchemaSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the schema was last updated.

', 'DatasetSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset was created.

', 'DatasetSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset was last updated.

', 'DatasetUpdateSummary$creationDateTime' => '

The creation date and time (in Unix time) of the dataset update.

', 'DatasetUpdateSummary$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the dataset.

', 'EventTracker$creationDateTime' => '

The date and time (in Unix format) that the event tracker was created.

', 'EventTracker$lastUpdatedDateTime' => '

The date and time (in Unix time) that the event tracker was last updated.

', 'EventTrackerSummary$creationDateTime' => '

The date and time (in Unix time) that the event tracker was created.

', 'EventTrackerSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the event tracker was last updated.

', 'FeatureTransformation$creationDateTime' => '

The creation date and time (in Unix time) of the feature transformation.

', 'FeatureTransformation$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the feature transformation.

', 'Filter$creationDateTime' => '

The time at which the filter was created.

', 'Filter$lastUpdatedDateTime' => '

The time at which the filter was last updated.

', 'FilterSummary$creationDateTime' => '

The time at which the filter was created.

', 'FilterSummary$lastUpdatedDateTime' => '

The time at which the filter was last updated.

', 'MetricAttribution$creationDateTime' => '

The metric attribution\'s creation date time.

', 'MetricAttribution$lastUpdatedDateTime' => '

The metric attribution\'s last updated date time.

', 'MetricAttributionSummary$creationDateTime' => '

The metric attribution\'s creation date time.

', 'MetricAttributionSummary$lastUpdatedDateTime' => '

The metric attribution\'s last updated date time.

', 'Recipe$creationDateTime' => '

The date and time (in Unix format) that the recipe was created.

', 'Recipe$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recipe was last updated.

', 'RecipeSummary$creationDateTime' => '

The date and time (in Unix time) that the recipe was created.

', 'RecipeSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the recipe was last updated.

', 'Recommender$creationDateTime' => '

The date and time (in Unix format) that the recommender was created.

', 'Recommender$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recommender was last updated.

', 'RecommenderSummary$creationDateTime' => '

The date and time (in Unix format) that the recommender was created.

', 'RecommenderSummary$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recommender was last updated.

', 'RecommenderUpdateSummary$creationDateTime' => '

The date and time (in Unix format) that the recommender update was created.

', 'RecommenderUpdateSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the recommender update was last updated.

', 'Solution$creationDateTime' => '

The creation date and time (in Unix time) of the solution.

', 'Solution$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionSummary$creationDateTime' => '

The date and time (in Unix time) that the solution was created.

', 'SolutionSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionVersion$creationDateTime' => '

The date and time (in Unix time) that this version of the solution was created.

', 'SolutionVersion$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionVersionSummary$creationDateTime' => '

The date and time (in Unix time) that this version of a solution was created.

', 'SolutionVersionSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution version was last updated.

', ], ], 'DefaultCategoricalHyperParameterRange' => [ 'base' => '

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultCategoricalHyperParameterRanges$member' => NULL, ], ], 'DefaultCategoricalHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$categoricalHyperParameterRanges' => '

The categorical hyperparameters and their default ranges.

', ], ], 'DefaultContinuousHyperParameterRange' => [ 'base' => '

Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultContinuousHyperParameterRanges$member' => NULL, ], ], 'DefaultContinuousHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$continuousHyperParameterRanges' => '

The continuous hyperparameters and their default ranges.

', ], ], 'DefaultHyperParameterRanges' => [ 'base' => '

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

', 'refs' => [ 'Algorithm$defaultHyperParameterRanges' => '

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', ], ], 'DefaultIntegerHyperParameterRange' => [ 'base' => '

Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultIntegerHyperParameterRanges$member' => NULL, ], ], 'DefaultIntegerHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$integerHyperParameterRanges' => '

The integer-valued hyperparameters and their default ranges.

', ], ], 'DeleteCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchInferenceJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchInferenceJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchSegmentJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchSegmentJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataDeletionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataDeletionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventTrackerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureTransformationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureTransformationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFilterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'Recipe$description' => '

The description of the recipe.

', ], ], 'DockerURI' => [ 'base' => NULL, 'refs' => [ 'AlgorithmImage$dockerURI' => '

The URI of the Docker container for the algorithm image.

', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetGroupRequest$domain' => '

The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don\'t specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.

', 'CreateDatasetGroupResponse$domain' => '

The domain for the new Domain dataset group.

', 'CreateSchemaRequest$domain' => '

The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

', 'DatasetGroup$domain' => '

The domain of a Domain dataset group.

', 'DatasetGroupSummary$domain' => '

The domain of a Domain dataset group.

', 'DatasetSchema$domain' => '

The domain of a schema that you created for a dataset in a Domain dataset group.

', 'DatasetSchemaSummary$domain' => '

The domain of a schema that you created for a dataset in a Domain dataset group.

', 'ListRecipesRequest$domain' => '

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don\'t specify a domain, all recipes are returned.

', 'RecipeSummary$domain' => '

The domain of the recipe (if the recipe is a Domain dataset group use case).

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InvalidInputException$message' => NULL, 'InvalidNextTokenException$message' => NULL, 'LimitExceededException$message' => NULL, 'ResourceAlreadyExistsException$message' => NULL, 'ResourceInUseException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'TooManyTagKeysException$message' => NULL, 'TooManyTagsException$message' => NULL, ], ], 'EventTracker' => [ 'base' => '

Provides information about an event tracker.

', 'refs' => [ 'DescribeEventTrackerResponse$eventTracker' => '

An object that describes the event tracker.

', ], ], 'EventTrackerSummary' => [ 'base' => '

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

', 'refs' => [ 'EventTrackers$member' => NULL, ], ], 'EventTrackers' => [ 'base' => NULL, 'refs' => [ 'ListEventTrackersResponse$eventTrackers' => '

A list of event trackers.

', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$eventType' => '

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, \'click\' or \'like\') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

', 'MetricAttribute$eventType' => '

The metric\'s event type.

', 'Solution$eventType' => '

The event type (for example, \'click\' or \'like\') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

', 'SolutionVersion$eventType' => '

The event type (for example, \'click\' or \'like\') that is used for training the model.

', ], ], 'EventValueThreshold' => [ 'base' => NULL, 'refs' => [ 'SolutionConfig$eventValueThreshold' => '

Only events with a value greater than or equal to this threshold are used for training a model.

', ], ], 'ExcludedDatasetColumns' => [ 'base' => NULL, 'refs' => [ 'TrainingDataConfig$excludedDatasetColumns' => '

Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$failureReason' => '

If the batch inference job failed, the reason for the failure.

', 'BatchInferenceJobSummary$failureReason' => '

If the batch inference job failed, the reason for the failure.

', 'BatchSegmentJob$failureReason' => '

If the batch segment job failed, the reason for the failure.

', 'BatchSegmentJobSummary$failureReason' => '

If the batch segment job failed, the reason for the failure.

', 'Campaign$failureReason' => '

If a campaign fails, the reason behind the failure.

', 'CampaignSummary$failureReason' => '

If a campaign fails, the reason behind the failure.

', 'CampaignUpdateSummary$failureReason' => '

If a campaign update fails, the reason behind the failure.

', 'DataDeletionJob$failureReason' => '

If a data deletion job fails, provides the reason why.

', 'DataDeletionJobSummary$failureReason' => '

If a data deletion job fails, provides the reason why.

', 'DatasetExportJob$failureReason' => '

If a dataset export job fails, provides the reason why.

', 'DatasetExportJobSummary$failureReason' => '

If a dataset export job fails, the reason behind the failure.

', 'DatasetGroup$failureReason' => '

If creating a dataset group fails, provides the reason why.

', 'DatasetGroupSummary$failureReason' => '

If creating a dataset group fails, the reason behind the failure.

', 'DatasetImportJob$failureReason' => '

If a dataset import job fails, provides the reason why.

', 'DatasetImportJobSummary$failureReason' => '

If a dataset import job fails, the reason behind the failure.

', 'DatasetUpdateSummary$failureReason' => '

If updating a dataset fails, provides the reason why.

', 'Filter$failureReason' => '

If the filter failed, the reason for its failure.

', 'FilterSummary$failureReason' => '

If the filter failed, the reason for the failure.

', 'MetricAttribution$failureReason' => '

The metric attribution\'s failure reason.

', 'MetricAttributionSummary$failureReason' => '

The metric attribution\'s failure reason.

', 'Recommender$failureReason' => '

If a recommender fails, the reason behind the failure.

', 'RecommenderUpdateSummary$failureReason' => '

If a recommender update fails, the reason behind the failure.

', 'SolutionVersion$failureReason' => '

If training a solution version fails, the reason for the failure.

', 'SolutionVersionSummary$failureReason' => '

If a solution version fails, the reason behind the failure.

', ], ], 'FeatureTransformation' => [ 'base' => '

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

', 'refs' => [ 'DescribeFeatureTransformationResponse$featureTransformation' => '

A listing of the FeatureTransformation properties.

', ], ], 'FeatureTransformationParameters' => [ 'base' => NULL, 'refs' => [ 'SolutionConfig$featureTransformationParameters' => '

Lists the feature transformation parameters.

', ], ], 'FeaturizationParameters' => [ 'base' => NULL, 'refs' => [ 'FeatureTransformation$defaultParameters' => '

Provides the default parameters for feature transformation.

', ], ], 'FieldsForThemeGeneration' => [ 'base' => '

A string to string map of the configuration details for theme generation.

', 'refs' => [ 'ThemeGenerationConfig$fieldsForThemeGeneration' => '

Fields used to generate descriptive themes for a batch inference job.

', ], ], 'Filter' => [ 'base' => '

Contains information on a recommendation filter, including its ARN, status, and filter expression.

', 'refs' => [ 'DescribeFilterResponse$filter' => '

The filter\'s details.

', ], ], 'FilterExpression' => [ 'base' => NULL, 'refs' => [ 'CreateFilterRequest$filterExpression' => '

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

', 'Filter$filterExpression' => '

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

', ], ], 'FilterSummary' => [ 'base' => '

A short summary of a filter\'s attributes.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'ListFiltersResponse$Filters' => '

A list of returned filters.

', ], ], 'GetSolutionMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSolutionMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'HPOConfig' => [ 'base' => '

Describes the properties for hyperparameter optimization (HPO).

', 'refs' => [ 'SolutionConfig$hpoConfig' => '

Describes the properties for hyperparameter optimization (HPO).

', ], ], 'HPOObjective' => [ 'base' => '

The metric to optimize during hyperparameter optimization (HPO).

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', 'refs' => [ 'HPOConfig$hpoObjective' => '

The metric to optimize during HPO.

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', ], ], 'HPOObjectiveType' => [ 'base' => NULL, 'refs' => [ 'HPOObjective$type' => '

The type of the metric. Valid values are Maximize and Minimize.

', ], ], 'HPOResource' => [ 'base' => NULL, 'refs' => [ 'HPOResourceConfig$maxNumberOfTrainingJobs' => '

The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

', 'HPOResourceConfig$maxParallelTrainingJobs' => '

The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

', ], ], 'HPOResourceConfig' => [ 'base' => '

Describes the resource configuration for hyperparameter optimization (HPO).

', 'refs' => [ 'HPOConfig$hpoResourceConfig' => '

Describes the resource configuration for HPO.

', ], ], 'HyperParameterRanges' => [ 'base' => '

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

', 'refs' => [ 'HPOConfig$algorithmHyperParameterRanges' => '

The hyperparameters and their allowable ranges.

', ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'Algorithm$defaultHyperParameters' => '

Specifies the default hyperparameters.

', 'BatchInferenceJobConfig$itemExplorationConfig' => '

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.

', 'CampaignConfig$itemExplorationConfig' => '

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

', 'RecommenderConfig$itemExplorationConfig' => '

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

', 'SolutionConfig$algorithmHyperParameters' => '

Lists the algorithm hyperparameters and their values.

', 'TunedHPOParams$algorithmHyperParameters' => '

A list of the hyperparameter values of the best performing model.

', ], ], 'ImportMode' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetImportJobRequest$importMode' => '

Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven\'t imported bulk records into the dataset previously, you can only specify FULL.

', 'DatasetImportJob$importMode' => '

The import mode used by the dataset import job to import new records.

', 'DatasetImportJobSummary$importMode' => '

The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.

', ], ], 'IngestionMode' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetExportJobRequest$ingestionMode' => '

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

', 'DatasetExportJob$ingestionMode' => '

The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DataDeletionJob$numDeleted' => '

The number of records deleted by a COMPLETED job.

', ], ], 'IntegerHyperParameterRange' => [ 'base' => '

Provides the name and range of an integer-valued hyperparameter.

', 'refs' => [ 'IntegerHyperParameterRanges$member' => NULL, ], ], 'IntegerHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$integerHyperParameterRanges' => '

The integer-valued hyperparameters and their ranges.

', ], ], 'IntegerMaxValue' => [ 'base' => NULL, 'refs' => [ 'DefaultIntegerHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', 'IntegerHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', ], ], 'IntegerMinValue' => [ 'base' => NULL, 'refs' => [ 'DefaultIntegerHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', 'IntegerHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', ], ], 'InvalidInputException' => [ 'base' => '

Provide a valid value for the field or parameter.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The token is not valid.

', 'refs' => [], ], 'ItemAttribute' => [ 'base' => NULL, 'refs' => [ 'OptimizationObjective$itemAttribute' => '

The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetGroupRequest$kmsKeyArn' => '

The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.

', 'DatasetGroup$kmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

', 'S3DataConfig$kmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

', ], ], 'LimitExceededException' => [ 'base' => '

The limit on the number of requests per second has been exceeded.

', 'refs' => [], ], 'ListBatchInferenceJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchInferenceJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchSegmentJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchSegmentJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCampaignsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCampaignsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataDeletionJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataDeletionJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEventTrackersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventTrackersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFiltersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFiltersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecipesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecipesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsRequest$maxResults' => '

The maximum number of batch inference job results to return in each page. The default value is 100.

', 'ListBatchSegmentJobsRequest$maxResults' => '

The maximum number of batch segment job results to return in each page. The default value is 100.

', 'ListCampaignsRequest$maxResults' => '

The maximum number of campaigns to return.

', 'ListDataDeletionJobsRequest$maxResults' => '

The maximum number of data deletion jobs to return.

', 'ListDatasetExportJobsRequest$maxResults' => '

The maximum number of dataset export jobs to return.

', 'ListDatasetGroupsRequest$maxResults' => '

The maximum number of dataset groups to return.

', 'ListDatasetImportJobsRequest$maxResults' => '

The maximum number of dataset import jobs to return.

', 'ListDatasetsRequest$maxResults' => '

The maximum number of datasets to return.

', 'ListEventTrackersRequest$maxResults' => '

The maximum number of event trackers to return.

', 'ListFiltersRequest$maxResults' => '

The maximum number of filters to return.

', 'ListMetricAttributionMetricsRequest$maxResults' => '

The maximum number of metrics to return in one page of results.

', 'ListMetricAttributionsRequest$maxResults' => '

The maximum number of metric attributions to return in one page of results.

', 'ListRecipesRequest$maxResults' => '

The maximum number of recipes to return.

', 'ListRecommendersRequest$maxResults' => '

The maximum number of recommenders to return.

', 'ListSchemasRequest$maxResults' => '

The maximum number of schemas to return.

', 'ListSolutionVersionsRequest$maxResults' => '

The maximum number of solution versions to return.

', 'ListSolutionsRequest$maxResults' => '

The maximum number of solutions to return.

', ], ], 'MetricAttribute' => [ 'base' => '

Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

', 'refs' => [ 'MetricAttributes$member' => NULL, ], ], 'MetricAttributes' => [ 'base' => NULL, 'refs' => [ 'CreateMetricAttributionRequest$metrics' => '

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

', 'ListMetricAttributionMetricsResponse$metrics' => '

The metrics for the specified metric attribution.

', 'UpdateMetricAttributionRequest$addMetrics' => '

Add new metric attributes to the metric attribution.

', ], ], 'MetricAttributesNamesList' => [ 'base' => NULL, 'refs' => [ 'UpdateMetricAttributionRequest$removeMetrics' => '

Remove metric attributes from the metric attribution.

', ], ], 'MetricAttribution' => [ 'base' => '

Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

', 'refs' => [ 'DescribeMetricAttributionResponse$metricAttribution' => '

The details of the metric attribution.

', ], ], 'MetricAttributionOutput' => [ 'base' => '

The output configuration details for a metric attribution.

', 'refs' => [ 'CreateMetricAttributionRequest$metricsOutputConfig' => '

The output configuration details for the metric attribution.

', 'MetricAttribution$metricsOutputConfig' => '

The metric attribution\'s output configuration.

', 'UpdateMetricAttributionRequest$metricsOutputConfig' => '

An output config for the metric attribution.

', ], ], 'MetricAttributionSummary' => [ 'base' => '

Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.

', 'refs' => [ 'MetricAttributions$member' => NULL, ], ], 'MetricAttributions' => [ 'base' => NULL, 'refs' => [ 'ListMetricAttributionsResponse$metricAttributions' => '

The list of metric attributions.

', ], ], 'MetricExpression' => [ 'base' => NULL, 'refs' => [ 'MetricAttribute$expression' => '

The attribute\'s expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'AutoMLConfig$metricName' => '

The metric to optimize.

', 'HPOObjective$metricName' => '

The name of the metric.

', 'MetricAttribute$metricName' => '

The metric\'s name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

', 'MetricAttributesNamesList$member' => NULL, 'Metrics$key' => NULL, ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'HPOObjective$metricRegex' => '

A regular expression for finding the metric in the training job logs.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'Metrics$value' => NULL, ], ], 'Metrics' => [ 'base' => NULL, 'refs' => [ 'GetSolutionMetricsResponse$metrics' => '

The metrics for the solution version. For more information, see Evaluating a solution version with metrics .

', 'Recommender$modelMetrics' => '

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Algorithm$name' => '

The name of the algorithm.

', 'AlgorithmImage$name' => '

The name of the algorithm image.

', 'BatchInferenceJob$jobName' => '

The name of the batch inference job.

', 'BatchInferenceJobSummary$jobName' => '

The name of the batch inference job.

', 'BatchSegmentJob$jobName' => '

The name of the batch segment job.

', 'BatchSegmentJobSummary$jobName' => '

The name of the batch segment job.

', 'Campaign$name' => '

The name of the campaign.

', 'CampaignSummary$name' => '

The name of the campaign.

', 'CreateBatchInferenceJobRequest$jobName' => '

The name of the batch inference job to create.

', 'CreateBatchSegmentJobRequest$jobName' => '

The name of the batch segment job to create.

', 'CreateCampaignRequest$name' => '

A name for the new campaign. The campaign name must be unique within your account.

', 'CreateDataDeletionJobRequest$jobName' => '

The name for the data deletion job.

', 'CreateDatasetExportJobRequest$jobName' => '

The name for the dataset export job.

', 'CreateDatasetGroupRequest$name' => '

The name for the new dataset group.

', 'CreateDatasetImportJobRequest$jobName' => '

The name for the dataset import job.

', 'CreateDatasetRequest$name' => '

The name for the dataset.

', 'CreateEventTrackerRequest$name' => '

The name for the event tracker.

', 'CreateFilterRequest$name' => '

The name of the filter to create.

', 'CreateMetricAttributionRequest$name' => '

A name for the metric attribution.

', 'CreateRecommenderRequest$name' => '

The name of the recommender.

', 'CreateSchemaRequest$name' => '

The name for the schema.

', 'CreateSolutionRequest$name' => '

The name for the solution.

', 'CreateSolutionVersionRequest$name' => '

The name of the solution version.

', 'DataDeletionJob$jobName' => '

The name of the data deletion job.

', 'DataDeletionJobSummary$jobName' => '

The name of the data deletion job.

', 'Dataset$name' => '

The name of the dataset.

', 'DatasetExportJob$jobName' => '

The name of the export job.

', 'DatasetExportJobSummary$jobName' => '

The name of the dataset export job.

', 'DatasetGroup$name' => '

The name of the dataset group.

', 'DatasetGroupSummary$name' => '

The name of the dataset group.

', 'DatasetImportJob$jobName' => '

The name of the import job.

', 'DatasetImportJobSummary$jobName' => '

The name of the dataset import job.

', 'DatasetSchema$name' => '

The name of the schema.

', 'DatasetSchemaSummary$name' => '

The name of the schema.

', 'DatasetSummary$name' => '

The name of the dataset.

', 'EventTracker$name' => '

The name of the event tracker.

', 'EventTrackerSummary$name' => '

The name of the event tracker.

', 'FeatureTransformation$name' => '

The name of the feature transformation.

', 'Filter$name' => '

The name of the filter.

', 'FilterSummary$name' => '

The name of the filter.

', 'MetricAttribution$name' => '

The metric attribution\'s name.

', 'MetricAttributionSummary$name' => '

The name of the metric attribution.

', 'Recipe$name' => '

The name of the recipe.

', 'RecipeSummary$name' => '

The name of the recipe.

', 'Recommender$name' => '

The name of the recommender.

', 'RecommenderSummary$name' => '

The name of the recommender.

', 'Solution$name' => '

The name of the solution.

', 'SolutionSummary$name' => '

The name of the solution.

', 'SolutionVersion$name' => '

The name of the solution version.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsRequest$nextToken' => '

The token to request the next page of results.

', 'ListBatchInferenceJobsResponse$nextToken' => '

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

', 'ListBatchSegmentJobsRequest$nextToken' => '

The token to request the next page of results.

', 'ListBatchSegmentJobsResponse$nextToken' => '

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

', 'ListCampaignsRequest$nextToken' => '

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

', 'ListCampaignsResponse$nextToken' => '

A token for getting the next set of campaigns (if they exist).

', 'ListDataDeletionJobsRequest$nextToken' => '

A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).

', 'ListDataDeletionJobsResponse$nextToken' => '

A token for getting the next set of data deletion jobs (if they exist).

', 'ListDatasetExportJobsRequest$nextToken' => '

A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

', 'ListDatasetExportJobsResponse$nextToken' => '

A token for getting the next set of dataset export jobs (if they exist).

', 'ListDatasetGroupsRequest$nextToken' => '

A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

', 'ListDatasetGroupsResponse$nextToken' => '

A token for getting the next set of dataset groups (if they exist).

', 'ListDatasetImportJobsRequest$nextToken' => '

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetImportJobsResponse$nextToken' => '

A token for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetsRequest$nextToken' => '

A token returned from the previous call to ListDatasets for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetsResponse$nextToken' => '

A token for getting the next set of datasets (if they exist).

', 'ListEventTrackersRequest$nextToken' => '

A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

', 'ListEventTrackersResponse$nextToken' => '

A token for getting the next set of event trackers (if they exist).

', 'ListFiltersRequest$nextToken' => '

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

', 'ListFiltersResponse$nextToken' => '

A token for getting the next set of filters (if they exist).

', 'ListMetricAttributionMetricsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListMetricAttributionMetricsResponse$nextToken' => '

Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.

', 'ListMetricAttributionsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListMetricAttributionsResponse$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRecipesRequest$nextToken' => '

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

', 'ListRecipesResponse$nextToken' => '

A token for getting the next set of recipes.

', 'ListRecommendersRequest$nextToken' => '

A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

', 'ListRecommendersResponse$nextToken' => '

A token for getting the next set of recommenders (if they exist).

', 'ListSchemasRequest$nextToken' => '

A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

', 'ListSchemasResponse$nextToken' => '

A token used to get the next set of schemas (if they exist).

', 'ListSolutionVersionsRequest$nextToken' => '

A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

', 'ListSolutionVersionsResponse$nextToken' => '

A token for getting the next set of solution versions (if they exist).

', 'ListSolutionsRequest$nextToken' => '

A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

', 'ListSolutionsResponse$nextToken' => '

A token for getting the next set of solutions (if they exist).

', ], ], 'NumBatchResults' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$numResults' => '

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

', 'BatchSegmentJob$numResults' => '

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

', 'CreateBatchInferenceJobRequest$numResults' => '

The number of recommendations to retrieve.

', 'CreateBatchSegmentJobRequest$numResults' => '

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

', ], ], 'ObjectiveSensitivity' => [ 'base' => NULL, 'refs' => [ 'OptimizationObjective$objectiveSensitivity' => '

Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

', ], ], 'OptimizationObjective' => [ 'base' => '

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

', 'refs' => [ 'SolutionConfig$optimizationObjective' => '

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'CategoricalHyperParameterRange$name' => '

The name of the hyperparameter.

', 'ContinuousHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultCategoricalHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultContinuousHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultIntegerHyperParameterRange$name' => '

The name of the hyperparameter.

', 'FeatureTransformationParameters$key' => NULL, 'FeaturizationParameters$key' => NULL, 'HyperParameters$key' => NULL, 'IntegerHyperParameterRange$name' => '

The name of the hyperparameter.

', 'ResourceConfig$key' => NULL, ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureTransformationParameters$value' => NULL, 'FeaturizationParameters$value' => NULL, 'HyperParameters$value' => NULL, 'ResourceConfig$value' => NULL, ], ], 'PerformAutoML' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$performAutoML' => '

We don\'t recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

', 'Solution$performAutoML' => '

We don\'t recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

', 'SolutionVersion$performAutoML' => '

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

', ], ], 'PerformAutoTraining' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$performAutoTraining' => '

Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

After training starts, you can get the solution version\'s Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

', 'Solution$performAutoTraining' => '

Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.

For more information about auto training, see Creating and configuring a solution.

', ], ], 'PerformHPO' => [ 'base' => NULL, 'refs' => [ 'Solution$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

', 'SolutionVersion$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

', ], ], 'Recipe' => [ 'base' => '

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.

', 'refs' => [ 'DescribeRecipeResponse$recipe' => '

An object that describes the recipe.

', ], ], 'RecipeProvider' => [ 'base' => NULL, 'refs' => [ 'ListRecipesRequest$recipeProvider' => '

The default is SERVICE.

', ], ], 'RecipeSummary' => [ 'base' => '

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

', 'refs' => [ 'Recipes$member' => NULL, ], ], 'RecipeType' => [ 'base' => NULL, 'refs' => [ 'Recipe$recipeType' => '

One of the following values:

', ], ], 'Recipes' => [ 'base' => NULL, 'refs' => [ 'ListRecipesResponse$recipes' => '

The list of available recipes.

', ], ], 'Recommender' => [ 'base' => '

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

', 'refs' => [ 'DescribeRecommenderResponse$recommender' => '

The properties of the recommender.

', ], ], 'RecommenderConfig' => [ 'base' => '

The configuration details of the recommender.

', 'refs' => [ 'CreateRecommenderRequest$recommenderConfig' => '

The configuration details of the recommender.

', 'Recommender$recommenderConfig' => '

The configuration details of the recommender.

', 'RecommenderSummary$recommenderConfig' => '

The configuration details of the recommender.

', 'RecommenderUpdateSummary$recommenderConfig' => '

The configuration details of the recommender update.

', 'UpdateRecommenderRequest$recommenderConfig' => '

The configuration details of the recommender.

', ], ], 'RecommenderSummary' => [ 'base' => '

Provides a summary of the properties of the recommender.

', 'refs' => [ 'Recommenders$member' => NULL, ], ], 'RecommenderUpdateSummary' => [ 'base' => '

Provides a summary of the properties of a recommender update. For a complete listing, call the DescribeRecommender API.

', 'refs' => [ 'Recommender$latestRecommenderUpdate' => '

Provides a summary of the latest updates to the recommender.

', ], ], 'Recommenders' => [ 'base' => NULL, 'refs' => [ 'ListRecommendersResponse$recommenders' => '

A list of the recommenders.

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

The specified resource already exists.

', 'refs' => [], ], 'ResourceConfig' => [ 'base' => NULL, 'refs' => [ 'Algorithm$defaultResourceConfig' => '

Specifies the default maximum number of training jobs and parallel training jobs.

', ], ], 'ResourceInUseException' => [ 'base' => '

The specified resource is in use.

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

Could not find the specified resource.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$roleArn' => '

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

', 'BatchSegmentJob$roleArn' => '

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

', 'CreateBatchInferenceJobRequest$roleArn' => '

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

', 'CreateBatchSegmentJobRequest$roleArn' => '

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

', 'CreateDataDeletionJobRequest$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

', 'CreateDatasetExportJobRequest$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

', 'CreateDatasetGroupRequest$roleArn' => '

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

', 'CreateDatasetImportJobRequest$roleArn' => '

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DataDeletionJob$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DatasetGroup$roleArn' => '

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

', 'MetricAttributionOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.

', ], ], 'S3DataConfig' => [ 'base' => '

The configuration details of an Amazon S3 input or output bucket.

', 'refs' => [ 'BatchInferenceJobInput$s3DataSource' => '

The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.

', 'BatchInferenceJobOutput$s3DataDestination' => '

Information on the Amazon S3 bucket in which the batch inference job\'s output is stored.

', 'BatchSegmentJobInput$s3DataSource' => NULL, 'BatchSegmentJobOutput$s3DataDestination' => NULL, 'DatasetExportJobOutput$s3DataDestination' => NULL, 'MetricAttributionOutput$s3DataDestination' => NULL, ], ], 'S3Location' => [ 'base' => NULL, 'refs' => [ 'DataSource$dataLocation' => '

For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.

For example:

s3://bucket-name/folder-name/fileName.csv

If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder name:

s3://bucket-name/folder-name/

', 'S3DataConfig$path' => '

The file path of the Amazon S3 bucket.

', ], ], 'SchedulingExpression' => [ 'base' => NULL, 'refs' => [ 'AutoTrainingConfig$schedulingExpression' => '

Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

For more information about auto training, see Creating and configuring a solution.

', ], ], 'Schemas' => [ 'base' => NULL, 'refs' => [ 'ListSchemasResponse$schemas' => '

A list of schemas.

', ], ], 'Solution' => [ 'base' => '

After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can\'t stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.

', 'refs' => [ 'DescribeSolutionResponse$solution' => '

An object that describes the solution.

', ], ], 'SolutionConfig' => [ 'base' => '

Describes the configuration properties for the solution.

', 'refs' => [ 'CreateSolutionRequest$solutionConfig' => '

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', 'Solution$solutionConfig' => '

Describes the configuration properties for the solution.

', 'SolutionVersion$solutionConfig' => '

Describes the configuration properties for the solution.

', ], ], 'SolutionSummary' => [ 'base' => '

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.

', 'refs' => [ 'Solutions$member' => NULL, ], ], 'SolutionVersion' => [ 'base' => '

An object that provides information about a specific version of a Solution in a Custom dataset group.

', 'refs' => [ 'DescribeSolutionVersionResponse$solutionVersion' => '

The solution version.

', ], ], 'SolutionVersionSummary' => [ 'base' => '

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

', 'refs' => [ 'Solution$latestSolutionVersion' => '

Describes the latest version of the solution, including the status and the ARN.

', 'SolutionVersions$member' => NULL, ], ], 'SolutionVersions' => [ 'base' => NULL, 'refs' => [ 'ListSolutionVersionsResponse$solutionVersions' => '

A list of solution versions describing the version properties.

', ], ], 'Solutions' => [ 'base' => NULL, 'refs' => [ 'ListSolutionsResponse$solutions' => '

A list of the current solutions.

', ], ], 'StartRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$status' => '

The status of the batch inference job. The status is one of the following values:

', 'BatchInferenceJobSummary$status' => '

The status of the batch inference job. The status is one of the following values:

', 'BatchSegmentJob$status' => '

The status of the batch segment job. The status is one of the following values:

', 'BatchSegmentJobSummary$status' => '

The status of the batch segment job. The status is one of the following values:

', 'Campaign$status' => '

The status of the campaign.

A campaign can be in one of the following states:

', 'CampaignSummary$status' => '

The status of the campaign.

A campaign can be in one of the following states:

', 'CampaignUpdateSummary$status' => '

The status of the campaign update.

A campaign update can be in one of the following states:

', 'DataDeletionJob$status' => '

The status of the data deletion job.

A data deletion job can have one of the following statuses:

', 'DataDeletionJobSummary$status' => '

The status of the data deletion job.

A data deletion job can have one of the following statuses:

', 'Dataset$status' => '

The status of the dataset.

A dataset can be in one of the following states:

', 'DatasetExportJob$status' => '

The status of the dataset export job.

A dataset export job can be in one of the following states:

', 'DatasetExportJobSummary$status' => '

The status of the dataset export job.

A dataset export job can be in one of the following states:

', 'DatasetGroup$status' => '

The current status of the dataset group.

A dataset group can be in one of the following states:

', 'DatasetGroupSummary$status' => '

The status of the dataset group.

A dataset group can be in one of the following states:

', 'DatasetImportJob$status' => '

The status of the dataset import job.

A dataset import job can be in one of the following states:

', 'DatasetImportJobSummary$status' => '

The status of the dataset import job.

A dataset import job can be in one of the following states:

', 'DatasetSummary$status' => '

The status of the dataset.

A dataset can be in one of the following states:

', 'DatasetUpdateSummary$status' => '

The status of the dataset update.

', 'EventTracker$status' => '

The status of the event tracker.

An event tracker can be in one of the following states:

', 'EventTrackerSummary$status' => '

The status of the event tracker.

An event tracker can be in one of the following states:

', 'FeatureTransformation$status' => '

The status of the feature transformation.

A feature transformation can be in one of the following states:

', 'Filter$status' => '

The status of the filter.

', 'FilterSummary$status' => '

The status of the filter.

', 'MetricAttribution$status' => '

The metric attribution\'s status.

', 'MetricAttributionSummary$status' => '

The metric attribution\'s status.

', 'Recipe$status' => '

The status of the recipe.

', 'RecipeSummary$status' => '

The status of the recipe.

', 'Recommender$status' => '

The status of the recommender.

A recommender can be in one of the following states:

', 'RecommenderSummary$status' => '

The status of the recommender. A recommender can be in one of the following states:

', 'RecommenderUpdateSummary$status' => '

The status of the recommender update.

A recommender can be in one of the following states:

', 'Solution$status' => '

The status of the solution.

A solution can be in one of the following states:

', 'SolutionSummary$status' => '

The status of the solution.

A solution can be in one of the following states:

', 'SolutionVersion$status' => '

The status of the solution version.

A solution version can be in one of the following states:

', 'SolutionVersionSummary$status' => '

The status of the solution version.

A solution version can be in one of the following states:

', ], ], 'StopRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSolutionVersionCreationRequest' => [ 'base' => NULL, 'refs' => [], ], 'Tag' => [ 'base' => '

The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$tagKey' => '

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The keys of the tags to be removed.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$tagValue' => '

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateBatchInferenceJobRequest$tags' => '

A list of tags to apply to the batch inference job.

', 'CreateBatchSegmentJobRequest$tags' => '

A list of tags to apply to the batch segment job.

', 'CreateCampaignRequest$tags' => '

A list of tags to apply to the campaign.

', 'CreateDataDeletionJobRequest$tags' => '

A list of tags to apply to the data deletion job.

', 'CreateDatasetExportJobRequest$tags' => '

A list of tags to apply to the dataset export job.

', 'CreateDatasetGroupRequest$tags' => '

A list of tags to apply to the dataset group.

', 'CreateDatasetImportJobRequest$tags' => '

A list of tags to apply to the dataset import job.

', 'CreateDatasetRequest$tags' => '

A list of tags to apply to the dataset.

', 'CreateEventTrackerRequest$tags' => '

A list of tags to apply to the event tracker.

', 'CreateFilterRequest$tags' => '

A list of tags to apply to the filter.

', 'CreateRecommenderRequest$tags' => '

A list of tags to apply to the recommender.

', 'CreateSolutionRequest$tags' => '

A list of tags to apply to the solution.

', 'CreateSolutionVersionRequest$tags' => '

A list of tags to apply to the solution version.

', 'ListTagsForResourceResponse$tags' => '

The resource\'s tags.

', 'TagResourceRequest$tags' => '

Tags to apply to the resource. For more information see Tagging Amazon Personalize resources.

', ], ], 'ThemeGenerationConfig' => [ 'base' => '

The configuration details for generating themes with a batch inference job.

', 'refs' => [ 'BatchInferenceJob$themeGenerationConfig' => '

The job\'s theme generation settings.

', 'CreateBatchInferenceJobRequest$themeGenerationConfig' => '

For theme generation jobs, specify the name of the column in your Items dataset that contains each item\'s name.

', ], ], 'TooManyTagKeysException' => [ 'base' => '

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

', 'refs' => [], ], 'TooManyTagsException' => [ 'base' => '

You have exceeded the maximum number of tags you can apply to this resource.

', 'refs' => [], ], 'TrackingId' => [ 'base' => NULL, 'refs' => [ 'CreateEventTrackerResponse$trackingId' => '

The ID of the event tracker. Include this ID in requests to the PutEvents API.

', 'Dataset$trackingId' => '

The ID of the event tracker for an Action interactions dataset. You specify the tracker\'s ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

', 'EventTracker$trackingId' => '

The ID of the event tracker. Include this ID in requests to the PutEvents API.

', ], ], 'TrainingDataConfig' => [ 'base' => '

The training data configuration to use when creating a domain recommender or custom solution version (trained model).

', 'refs' => [ 'RecommenderConfig$trainingDataConfig' => '

Specifies the training data configuration to use when creating a domain recommender.

', 'SolutionConfig$trainingDataConfig' => '

Specifies the training data configuration to use when creating a custom solution version (trained model).

', ], ], 'TrainingHours' => [ 'base' => NULL, 'refs' => [ 'SolutionVersion$trainingHours' => '

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

', ], ], 'TrainingInputMode' => [ 'base' => NULL, 'refs' => [ 'Algorithm$trainingInputMode' => '

The training input mode.

', ], ], 'TrainingMode' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionVersionRequest$trainingMode' => '

The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group.

If you use User-Personalization, you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the legacy HRNN-Coldstart recipe.

', 'SolutionVersion$trainingMode' => '

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

', 'SolutionVersionSummary$trainingMode' => '

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

', ], ], 'TrainingType' => [ 'base' => NULL, 'refs' => [ 'SolutionVersion$trainingType' => '

Whether the solution version was created automatically or manually.

', 'SolutionVersionSummary$trainingType' => '

Whether the solution version was created automatically or manually.

', ], ], 'TransactionsPerSecond' => [ 'base' => NULL, 'refs' => [ 'Campaign$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', 'CampaignUpdateSummary$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

', 'CreateCampaignRequest$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', 'RecommenderConfig$minRecommendationRequestsPerSecond' => '

Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

', 'UpdateCampaignRequest$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', ], ], 'Tunable' => [ 'base' => NULL, 'refs' => [ 'DefaultCategoricalHyperParameterRange$isTunable' => '

Whether the hyperparameter is tunable.

', 'DefaultContinuousHyperParameterRange$isTunable' => '

Whether the hyperparameter is tunable.

', 'DefaultIntegerHyperParameterRange$isTunable' => '

Indicates whether the hyperparameter is tunable.

', ], ], 'TunedHPOParams' => [ 'base' => '

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.

', 'refs' => [ 'SolutionVersion$tunedHPOParams' => '

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'service' => '

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

', 'operations' => [ 'CreateBatchInferenceJob' => '

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job\'s mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can\'t get batch recommendations with the Trending-Now or Next-Best-Action recipes.

', 'CreateBatchSegmentJob' => '

Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.

', 'CreateCampaign' => '

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There\'s a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

Status

A campaign can be in one of the following states:

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

', 'CreateDataDeletionJob' => '

Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.

After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.

Status

A data deletion job can have one of the following statuses:

To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

', 'CreateDataset' => '

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are 5 types of datasets:

Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

To get the status of the dataset, call DescribeDataset.

Related APIs

', 'CreateDatasetExportJob' => '

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

', 'CreateDatasetGroup' => '

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.

A dataset group can be in one of the following states:

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

Related APIs

', 'CreateDatasetImportJob' => '

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.

Status

A dataset import job can be in one of the following states:

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

', 'CreateEventTracker' => '

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

', 'CreateFilter' => '

Creates a recommendation filter. For more information, see Filtering recommendations and user segments.

', 'CreateMetricAttribution' => '

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

', 'CreateRecommender' => '

Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender\'s Amazon Resource Name (ARN) when you make a GetRecommendations request.

Minimum recommendation requests per second

A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

When you create a recommender, you can configure the recommender\'s minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.

If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There\'s a short time delay while the capacity is increased that might cause loss of requests.

Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.

Status

A recommender can be in one of the following states:

To get the recommender status, call DescribeRecommender.

Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.

Related APIs

', 'CreateSchema' => '

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

Related APIs

', 'CreateSolution' => '

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

After training starts, you can get the solution version\'s Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

Amazon Personalize doesn\'t support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

', 'CreateSolutionVersion' => '

Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

', 'DeleteCampaign' => '

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.

', 'DeleteDataset' => '

Deletes a dataset. You can\'t delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

', 'DeleteDatasetGroup' => '

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

', 'DeleteEventTracker' => '

Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

', 'DeleteFilter' => '

Deletes a filter.

', 'DeleteMetricAttribution' => '

Deletes a metric attribution.

', 'DeleteRecommender' => '

Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.

', 'DeleteSchema' => '

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

', 'DeleteSolution' => '

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can\'t delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

', 'DescribeAlgorithm' => '

Describes the given algorithm.

', 'DescribeBatchInferenceJob' => '

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

', 'DescribeBatchSegmentJob' => '

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

', 'DescribeCampaign' => '

Describes the given campaign, including its status.

A campaign can be in one of the following states:

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

', 'DescribeDataDeletionJob' => '

Describes the data deletion job created by CreateDataDeletionJob, including the job status.

', 'DescribeDataset' => '

Describes the given dataset. For more information on datasets, see CreateDataset.

', 'DescribeDatasetExportJob' => '

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

', 'DescribeDatasetGroup' => '

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

', 'DescribeDatasetImportJob' => '

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

', 'DescribeEventTracker' => '

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

', 'DescribeFeatureTransformation' => '

Describes the given feature transformation.

', 'DescribeFilter' => '

Describes a filter\'s properties.

', 'DescribeMetricAttribution' => '

Describes a metric attribution.

', 'DescribeRecipe' => '

Describes a recipe.

A recipe contains three items:

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

', 'DescribeRecommender' => '

Describes the given recommender, including its status.

A recommender can be in one of the following states:

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

', 'DescribeSchema' => '

Describes a schema. For more information on schemas, see CreateSchema.

', 'DescribeSolution' => '

Describes a solution. For more information on solutions, see CreateSolution.

', 'DescribeSolutionVersion' => '

Describes a specific version of a solution. For more information on solutions, see CreateSolution

', 'GetSolutionMetrics' => '

Gets the metrics for the specified solution version.

', 'ListBatchInferenceJobs' => '

Gets a list of the batch inference jobs that have been performed off of a solution version.

', 'ListBatchSegmentJobs' => '

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

', 'ListCampaigns' => '

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

', 'ListDataDeletionJobs' => '

Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.

', 'ListDatasetExportJobs' => '

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

', 'ListDatasetGroups' => '

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

', 'ListDatasetImportJobs' => '

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

', 'ListDatasets' => '

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

', 'ListEventTrackers' => '

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

', 'ListFilters' => '

Lists all filters that belong to a given dataset group.

', 'ListMetricAttributionMetrics' => '

Lists the metrics for the metric attribution.

', 'ListMetricAttributions' => '

Lists metric attributions.

', 'ListRecipes' => '

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe\'s Amazon Resource Name (ARN).

', 'ListRecommenders' => '

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.

', 'ListSchemas' => '

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

', 'ListSolutionVersions' => '

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).

', 'ListSolutions' => '

Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

', 'ListTagsForResource' => '

Get a list of tags attached to a resource.

', 'StartRecommender' => '

Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.

', 'StopRecommender' => '

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

', 'StopSolutionVersionCreation' => '

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

', 'TagResource' => '

Add a list of tags to a resource.

', 'UntagResource' => '

Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.

', 'UpdateCampaign' => '

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign\'s minProvisionedTPS, or modify your campaign\'s configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

', 'UpdateDataset' => '

Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset\'s schema.

', 'UpdateMetricAttribution' => '

Updates a metric attribution.

', 'UpdateRecommender' => '

Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

', 'UpdateSolution' => '

Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.

A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.

', ], 'shapes' => [ 'AccountId' => [ 'base' => NULL, 'refs' => [ 'EventTracker$accountId' => '

The Amazon Web Services account that owns the event tracker.

', ], ], 'Algorithm' => [ 'base' => '

Describes a custom algorithm.

', 'refs' => [ 'DescribeAlgorithmResponse$algorithm' => '

A listing of the properties of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => '

Describes an algorithm image.

', 'refs' => [ 'Algorithm$algorithmImage' => '

The URI of the Docker container for the algorithm image.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'Algorithm$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'Algorithm$roleArn' => '

The Amazon Resource Name (ARN) of the role.

', 'ArnList$member' => NULL, 'AutoMLResult$bestRecipeArn' => '

The Amazon Resource Name (ARN) of the best recipe.

', 'BatchInferenceJob$batchInferenceJobArn' => '

The Amazon Resource Name (ARN) of the batch inference job.

', 'BatchInferenceJob$filterArn' => '

The ARN of the filter used on the batch inference job.

', 'BatchInferenceJob$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

', 'BatchInferenceJobSummary$batchInferenceJobArn' => '

The Amazon Resource Name (ARN) of the batch inference job.

', 'BatchInferenceJobSummary$solutionVersionArn' => '

The ARN of the solution version used by the batch inference job.

', 'BatchSegmentJob$batchSegmentJobArn' => '

The Amazon Resource Name (ARN) of the batch segment job.

', 'BatchSegmentJob$filterArn' => '

The ARN of the filter used on the batch segment job.

', 'BatchSegmentJob$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

', 'BatchSegmentJobSummary$batchSegmentJobArn' => '

The Amazon Resource Name (ARN) of the batch segment job.

', 'BatchSegmentJobSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

', 'Campaign$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'Campaign$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version the campaign uses.

', 'CampaignSummary$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'CampaignUpdateSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the deployed solution version.

', 'CreateBatchInferenceJobRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

', 'CreateBatchInferenceJobRequest$filterArn' => '

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

', 'CreateBatchInferenceJobResponse$batchInferenceJobArn' => '

The ARN of the batch inference job.

', 'CreateBatchSegmentJobRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

', 'CreateBatchSegmentJobRequest$filterArn' => '

The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

', 'CreateBatchSegmentJobResponse$batchSegmentJobArn' => '

The ARN of the batch segment job.

', 'CreateCampaignRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn\'t the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'CreateCampaignResponse$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'CreateDataDeletionJobRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.

', 'CreateDataDeletionJobResponse$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'CreateDatasetExportJobRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

', 'CreateDatasetExportJobResponse$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'CreateDatasetGroupResponse$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the new dataset group.

', 'CreateDatasetImportJobRequest$datasetArn' => '

The ARN of the dataset that receives the imported data.

', 'CreateDatasetImportJobResponse$datasetImportJobArn' => '

The ARN of the dataset import job.

', 'CreateDatasetRequest$schemaArn' => '

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

', 'CreateDatasetRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

', 'CreateDatasetResponse$datasetArn' => '

The ARN of the dataset.

', 'CreateEventTrackerRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

', 'CreateEventTrackerResponse$eventTrackerArn' => '

The ARN of the event tracker.

', 'CreateFilterRequest$datasetGroupArn' => '

The ARN of the dataset group that the filter will belong to.

', 'CreateFilterResponse$filterArn' => '

The ARN of the new filter.

', 'CreateMetricAttributionRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

', 'CreateMetricAttributionResponse$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the new metric attribution.

', 'CreateRecommenderRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

', 'CreateRecommenderRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

', 'CreateRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'CreateSchemaResponse$schemaArn' => '

The Amazon Resource Name (ARN) of the created schema.

', 'CreateSolutionRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

', 'CreateSolutionRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

', 'CreateSolutionResponse$solutionArn' => '

The ARN of the solution.

', 'CreateSolutionVersionRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

', 'CreateSolutionVersionResponse$solutionVersionArn' => '

The ARN of the new solution version.

', 'DataDeletionJob$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DataDeletionJob$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

', 'DataDeletionJobSummary$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DataDeletionJobSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group the job deleted records from.

', 'Dataset$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

', 'Dataset$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'Dataset$schemaArn' => '

The ARN of the associated schema.

', 'DatasetExportJob$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'DatasetExportJob$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to export.

', 'DatasetExportJob$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

', 'DatasetExportJobSummary$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job.

', 'DatasetGroup$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'DatasetGroupSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'DatasetImportJob$datasetImportJobArn' => '

The ARN of the dataset import job.

', 'DatasetImportJob$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

', 'DatasetImportJob$roleArn' => '

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DatasetImportJobSummary$datasetImportJobArn' => '

The Amazon Resource Name (ARN) of the dataset import job.

', 'DatasetSchema$schemaArn' => '

The Amazon Resource Name (ARN) of the schema.

', 'DatasetSchemaSummary$schemaArn' => '

The Amazon Resource Name (ARN) of the schema.

', 'DatasetSummary$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DatasetUpdateSummary$schemaArn' => '

The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

', 'DeleteCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign to delete.

', 'DeleteDatasetGroupRequest$datasetGroupArn' => '

The ARN of the dataset group to delete.

', 'DeleteDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to delete.

', 'DeleteEventTrackerRequest$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker to delete.

', 'DeleteFilterRequest$filterArn' => '

The ARN of the filter to delete.

', 'DeleteMetricAttributionRequest$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'DeleteRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to delete.

', 'DeleteSchemaRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the schema to delete.

', 'DeleteSolutionRequest$solutionArn' => '

The ARN of the solution to delete.

', 'DescribeAlgorithmRequest$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm to describe.

', 'DescribeBatchInferenceJobRequest$batchInferenceJobArn' => '

The ARN of the batch inference job to describe.

', 'DescribeBatchSegmentJobRequest$batchSegmentJobArn' => '

The ARN of the batch segment job to describe.

', 'DescribeCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'DescribeDataDeletionJobRequest$dataDeletionJobArn' => '

The Amazon Resource Name (ARN) of the data deletion job.

', 'DescribeDatasetExportJobRequest$datasetExportJobArn' => '

The Amazon Resource Name (ARN) of the dataset export job to describe.

', 'DescribeDatasetGroupRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to describe.

', 'DescribeDatasetImportJobRequest$datasetImportJobArn' => '

The Amazon Resource Name (ARN) of the dataset import job to describe.

', 'DescribeDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to describe.

', 'DescribeEventTrackerRequest$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker to describe.

', 'DescribeFeatureTransformationRequest$featureTransformationArn' => '

The Amazon Resource Name (ARN) of the feature transformation to describe.

', 'DescribeFilterRequest$filterArn' => '

The ARN of the filter to describe.

', 'DescribeMetricAttributionRequest$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'DescribeRecipeRequest$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe to describe.

', 'DescribeRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to describe.

', 'DescribeSchemaRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the schema to retrieve.

', 'DescribeSolutionRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution to describe.

', 'DescribeSolutionVersionRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version.

', 'EventTracker$eventTrackerArn' => '

The ARN of the event tracker.

', 'EventTracker$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

', 'EventTrackerSummary$eventTrackerArn' => '

The Amazon Resource Name (ARN) of the event tracker.

', 'FeatureTransformation$featureTransformationArn' => '

The Amazon Resource Name (ARN) of the FeatureTransformation object.

', 'Filter$filterArn' => '

The ARN of the filter.

', 'Filter$datasetGroupArn' => '

The ARN of the dataset group to which the filter belongs.

', 'FilterSummary$filterArn' => '

The ARN of the filter.

', 'FilterSummary$datasetGroupArn' => '

The ARN of the dataset group to which the filter belongs.

', 'GetSolutionMetricsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

', 'GetSolutionMetricsResponse$solutionVersionArn' => '

The same solution version ARN as specified in the request.

', 'ListBatchInferenceJobsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

', 'ListBatchSegmentJobsRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

', 'ListCampaignsRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

', 'ListDataDeletionJobsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.

', 'ListDatasetExportJobsRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.

', 'ListDatasetImportJobsRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

', 'ListDatasetsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

', 'ListEventTrackersRequest$datasetGroupArn' => '

The ARN of a dataset group used to filter the response.

', 'ListFiltersRequest$datasetGroupArn' => '

The ARN of the dataset group that contains the filters.

', 'ListMetricAttributionMetricsRequest$metricAttributionArn' => '

The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.

', 'ListMetricAttributionsRequest$datasetGroupArn' => '

The metric attributions\' dataset group Amazon Resource Name (ARN).

', 'ListRecommendersRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

', 'ListSolutionVersionsRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution.

', 'ListSolutionsRequest$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group.

', 'ListTagsForResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'MetricAttribution$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'MetricAttribution$datasetGroupArn' => '

The metric attribution\'s dataset group Amazon Resource Name (ARN).

', 'MetricAttributionSummary$metricAttributionArn' => '

The metric attribution\'s Amazon Resource Name (ARN).

', 'Recipe$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe.

', 'Recipe$algorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

', 'Recipe$featureTransformationArn' => '

The ARN of the FeatureTransformation object.

', 'RecipeSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe.

', 'Recommender$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'Recommender$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

', 'Recommender$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

', 'RecommenderSummary$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender.

', 'RecommenderSummary$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

', 'RecommenderSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

', 'Solution$solutionArn' => '

The ARN of the solution.

', 'Solution$recipeArn' => '

The ARN of the recipe used to create the solution. This is required when performAutoML is false.

', 'Solution$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

', 'SolutionSummary$solutionArn' => '

The Amazon Resource Name (ARN) of the solution.

', 'SolutionSummary$recipeArn' => '

The Amazon Resource Name (ARN) of the recipe used by the solution.

', 'SolutionVersion$solutionVersionArn' => '

The ARN of the solution version.

', 'SolutionVersion$solutionArn' => '

The ARN of the solution.

', 'SolutionVersion$recipeArn' => '

The ARN of the recipe used in the solution.

', 'SolutionVersion$datasetGroupArn' => '

The Amazon Resource Name (ARN) of the dataset group providing the training data.

', 'SolutionVersionSummary$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version.

', 'StartRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to start.

', 'StartRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender you started.

', 'StopRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to stop.

', 'StopRecommenderResponse$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender you stopped.

', 'StopSolutionVersionCreationRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of the solution version you want to stop creating.

', 'TagResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'UntagResourceRequest$resourceArn' => '

The resource\'s Amazon Resource Name (ARN).

', 'UpdateCampaignRequest$campaignArn' => '

The Amazon Resource Name (ARN) of the campaign.

', 'UpdateCampaignRequest$solutionVersionArn' => '

The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn\'t the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'UpdateCampaignResponse$campaignArn' => '

The same campaign ARN as given in the request.

', 'UpdateDatasetRequest$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset that you want to update.

', 'UpdateDatasetRequest$schemaArn' => '

The Amazon Resource Name (ARN) of the new schema you want use.

', 'UpdateDatasetResponse$datasetArn' => '

The Amazon Resource Name (ARN) of the dataset you updated.

', 'UpdateMetricAttributionRequest$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the metric attribution to update.

', 'UpdateMetricAttributionResponse$metricAttributionArn' => '

The Amazon Resource Name (ARN) for the metric attribution that you updated.

', 'UpdateRecommenderRequest$recommenderArn' => '

The Amazon Resource Name (ARN) of the recommender to modify.

', 'UpdateRecommenderResponse$recommenderArn' => '

The same recommender Amazon Resource Name (ARN) as given in the request.

', 'UpdateSolutionRequest$solutionArn' => '

The Amazon Resource Name (ARN) of the solution to update.

', 'UpdateSolutionResponse$solutionArn' => '

The same solution Amazon Resource Name (ARN) as given in the request.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'AutoMLConfig$recipeList' => '

The list of candidate recipes.

', ], ], 'AutoMLConfig' => [ 'base' => '

When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.

', 'refs' => [ 'SolutionConfig$autoMLConfig' => '

The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

', ], ], 'AutoMLResult' => [ 'base' => '

When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.

', 'refs' => [ 'Solution$autoMLResult' => '

When performAutoML is true, specifies the best recipe found.

', ], ], 'AutoTrainingConfig' => [ 'base' => '

The automatic training configuration to use when performAutoTraining is true.

', 'refs' => [ 'SolutionConfig$autoTrainingConfig' => '

Specifies the automatic training configuration to use.

', 'SolutionUpdateConfig$autoTrainingConfig' => NULL, ], ], 'AvroSchema' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaRequest$schema' => '

A schema in Avro JSON format.

', 'DatasetSchema$schema' => '

The schema.

', ], ], 'BatchInferenceJob' => [ 'base' => '

Contains information on a batch inference job.

', 'refs' => [ 'DescribeBatchInferenceJobResponse$batchInferenceJob' => '

Information on the specified batch inference job.

', ], ], 'BatchInferenceJobConfig' => [ 'base' => '

The configuration details of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$batchInferenceJobConfig' => '

A string to string map of the configuration details of a batch inference job.

', 'CreateBatchInferenceJobRequest$batchInferenceJobConfig' => '

The configuration details of a batch inference job.

', ], ], 'BatchInferenceJobInput' => [ 'base' => '

The input configuration of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$jobInput' => '

The Amazon S3 path that leads to the input data used to generate the batch inference job.

', 'CreateBatchInferenceJobRequest$jobInput' => '

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

', ], ], 'BatchInferenceJobMode' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$batchInferenceJobMode' => '

The job\'s mode.

', 'BatchInferenceJobSummary$batchInferenceJobMode' => '

The job\'s mode.

', 'CreateBatchInferenceJobRequest$batchInferenceJobMode' => '

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don\'t want to generate themes, use the default BATCH_INFERENCE.

When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

', ], ], 'BatchInferenceJobOutput' => [ 'base' => '

The output configuration parameters of a batch inference job.

', 'refs' => [ 'BatchInferenceJob$jobOutput' => '

The Amazon S3 bucket that contains the output data generated by the batch inference job.

', 'CreateBatchInferenceJobRequest$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output will be stored.

', ], ], 'BatchInferenceJobSummary' => [ 'base' => '

A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

', 'refs' => [ 'BatchInferenceJobs$member' => NULL, ], ], 'BatchInferenceJobs' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsResponse$batchInferenceJobs' => '

A list containing information on each job that is returned.

', ], ], 'BatchSegmentJob' => [ 'base' => '

Contains information on a batch segment job.

', 'refs' => [ 'DescribeBatchSegmentJobResponse$batchSegmentJob' => '

Information on the specified batch segment job.

', ], ], 'BatchSegmentJobInput' => [ 'base' => '

The input configuration of a batch segment job.

', 'refs' => [ 'BatchSegmentJob$jobInput' => '

The Amazon S3 path that leads to the input data used to generate the batch segment job.

', 'CreateBatchSegmentJobRequest$jobInput' => '

The Amazon S3 path for the input data used to generate the batch segment job.

', ], ], 'BatchSegmentJobOutput' => [ 'base' => '

The output configuration parameters of a batch segment job.

', 'refs' => [ 'BatchSegmentJob$jobOutput' => '

The Amazon S3 bucket that contains the output data generated by the batch segment job.

', 'CreateBatchSegmentJobRequest$jobOutput' => '

The Amazon S3 path for the bucket where the job\'s output will be stored.

', ], ], 'BatchSegmentJobSummary' => [ 'base' => '

A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.

', 'refs' => [ 'BatchSegmentJobs$member' => NULL, ], ], 'BatchSegmentJobs' => [ 'base' => NULL, 'refs' => [ 'ListBatchSegmentJobsResponse$batchSegmentJobs' => '

A list containing information on each job that is returned.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CampaignConfig$enableMetadataWithRecommendations' => '

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

', 'CampaignConfig$syncWithLatestSolutionVersion' => '

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

', 'CreateDatasetImportJobRequest$publishAttributionMetricsToS3' => '

If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

', 'CreateSolutionRequest$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

', 'DatasetImportJob$publishAttributionMetricsToS3' => '

Whether the job publishes metrics to Amazon S3 for a metric attribution.

', 'RecommenderConfig$enableMetadataWithRecommendations' => '

Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

', ], ], 'Campaign' => [ 'base' => '

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

', 'refs' => [ 'DescribeCampaignResponse$campaign' => '

The properties of the campaign.

', ], ], 'CampaignConfig' => [ 'base' => '

The configuration details of a campaign.

', 'refs' => [ 'Campaign$campaignConfig' => '

The configuration details of a campaign.

', 'CampaignUpdateSummary$campaignConfig' => NULL, 'CreateCampaignRequest$campaignConfig' => '

The configuration details of a campaign.

', 'UpdateCampaignRequest$campaignConfig' => '

The configuration details of a campaign.

', ], ], 'CampaignSummary' => [ 'base' => '

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

', 'refs' => [ 'Campaigns$member' => NULL, ], ], 'CampaignUpdateSummary' => [ 'base' => '

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

', 'refs' => [ 'Campaign$latestCampaignUpdate' => NULL, ], ], 'Campaigns' => [ 'base' => NULL, 'refs' => [ 'ListCampaignsResponse$campaigns' => '

A list of the campaigns.

', ], ], 'CategoricalHyperParameterRange' => [ 'base' => '

Provides the name and range of a categorical hyperparameter.

', 'refs' => [ 'CategoricalHyperParameterRanges$member' => NULL, ], ], 'CategoricalHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$categoricalHyperParameterRanges' => '

The categorical hyperparameters and their ranges.

', ], ], 'CategoricalValue' => [ 'base' => NULL, 'refs' => [ 'CategoricalValues$member' => NULL, ], ], 'CategoricalValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalHyperParameterRange$values' => '

A list of the categories for the hyperparameter.

', 'DefaultCategoricalHyperParameterRange$values' => '

A list of the categories for the hyperparameter.

', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'ColumnNamesList$member' => NULL, 'FieldsForThemeGeneration$itemName' => '

The name of the Items dataset column that stores the name of each item in the dataset.

', ], ], 'ColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'ExcludedDatasetColumns$value' => NULL, ], ], 'ContinuousHyperParameterRange' => [ 'base' => '

Provides the name and range of a continuous hyperparameter.

', 'refs' => [ 'ContinuousHyperParameterRanges$member' => NULL, ], ], 'ContinuousHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$continuousHyperParameterRanges' => '

The continuous hyperparameters and their ranges.

', ], ], 'ContinuousMaxValue' => [ 'base' => NULL, 'refs' => [ 'ContinuousHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', 'DefaultContinuousHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', ], ], 'ContinuousMinValue' => [ 'base' => NULL, 'refs' => [ 'ContinuousHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', 'DefaultContinuousHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', ], ], 'CreateBatchInferenceJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchInferenceJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchSegmentJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchSegmentJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataDeletionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataDeletionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventTrackerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFilterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSolutionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DataDeletionJob' => [ 'base' => '

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

', 'refs' => [ 'DescribeDataDeletionJobResponse$dataDeletionJob' => '

Information about the data deletion job, including the status.

The status is one of the following values:

', ], ], 'DataDeletionJobSummary' => [ 'base' => '

Provides a summary of the properties of a data deletion job. For a complete listing, call the DescribeDataDeletionJob API operation.

', 'refs' => [ 'DataDeletionJobs$member' => NULL, ], ], 'DataDeletionJobs' => [ 'base' => NULL, 'refs' => [ 'ListDataDeletionJobsResponse$dataDeletionJobs' => '

The list of data deletion jobs.

', ], ], 'DataSource' => [ 'base' => '

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

', 'refs' => [ 'CreateDataDeletionJobRequest$dataSource' => '

The Amazon S3 bucket that contains the list of userIds of the users to delete.

', 'CreateDatasetImportJobRequest$dataSource' => '

The Amazon S3 bucket that contains the training data to import.

', 'DataDeletionJob$dataSource' => NULL, 'DatasetImportJob$dataSource' => '

The Amazon S3 bucket that contains the training data to import.

', ], ], 'Dataset' => [ 'base' => '

Provides metadata for a dataset.

', 'refs' => [ 'DescribeDatasetResponse$dataset' => '

A listing of the dataset\'s properties.

', ], ], 'DatasetExportJob' => [ 'base' => '

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

A dataset export job can be in one of the following states:

', 'refs' => [ 'DescribeDatasetExportJobResponse$datasetExportJob' => '

Information about the dataset export job, including the status.

The status is one of the following values:

', ], ], 'DatasetExportJobOutput' => [ 'base' => '

The output configuration parameters of a dataset export job.

', 'refs' => [ 'CreateDatasetExportJobRequest$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output is stored.

', 'DatasetExportJob$jobOutput' => '

The path to the Amazon S3 bucket where the job\'s output is stored. For example:

s3://bucket-name/folder-name/

', ], ], 'DatasetExportJobSummary' => [ 'base' => '

Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.

', 'refs' => [ 'DatasetExportJobs$member' => NULL, ], ], 'DatasetExportJobs' => [ 'base' => NULL, 'refs' => [ 'ListDatasetExportJobsResponse$datasetExportJobs' => '

The list of dataset export jobs.

', ], ], 'DatasetGroup' => [ 'base' => '

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.

', 'refs' => [ 'DescribeDatasetGroupResponse$datasetGroup' => '

A listing of the dataset group\'s properties.

', ], ], 'DatasetGroupSummary' => [ 'base' => '

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

', 'refs' => [ 'DatasetGroups$member' => NULL, ], ], 'DatasetGroups' => [ 'base' => NULL, 'refs' => [ 'ListDatasetGroupsResponse$datasetGroups' => '

The list of your dataset groups.

', ], ], 'DatasetImportJob' => [ 'base' => '

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset import job can be in one of the following states:

', 'refs' => [ 'DescribeDatasetImportJobResponse$datasetImportJob' => '

Information about the dataset import job, including the status.

The status is one of the following values:

', ], ], 'DatasetImportJobSummary' => [ 'base' => '

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

', 'refs' => [ 'DatasetImportJobs$member' => NULL, ], ], 'DatasetImportJobs' => [ 'base' => NULL, 'refs' => [ 'ListDatasetImportJobsResponse$datasetImportJobs' => '

The list of dataset import jobs.

', ], ], 'DatasetSchema' => [ 'base' => '

Describes the schema for a dataset. For more information on schemas, see CreateSchema.

', 'refs' => [ 'DescribeSchemaResponse$schema' => '

The requested schema.

', ], ], 'DatasetSchemaSummary' => [ 'base' => '

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

', 'refs' => [ 'Schemas$member' => NULL, ], ], 'DatasetSummary' => [ 'base' => '

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

', 'refs' => [ 'Datasets$member' => NULL, ], ], 'DatasetType' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetRequest$datasetType' => '

The type of dataset.

One of the following (case insensitive) values:

', 'Dataset$datasetType' => '

One of the following values:

', 'DatasetSummary$datasetType' => '

The dataset type. One of the following values:

', 'ExcludedDatasetColumns$key' => NULL, ], ], 'DatasetUpdateSummary' => [ 'base' => '

Describes an update to a dataset.

', 'refs' => [ 'Dataset$latestDatasetUpdate' => '

Describes the latest update to the dataset.

', ], ], 'Datasets' => [ 'base' => NULL, 'refs' => [ 'ListDatasetsResponse$datasets' => '

An array of Dataset objects. Each object provides metadata information.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'Algorithm$creationDateTime' => '

The date and time (in Unix time) that the algorithm was created.

', 'Algorithm$lastUpdatedDateTime' => '

The date and time (in Unix time) that the algorithm was last updated.

', 'BatchInferenceJob$creationDateTime' => '

The time at which the batch inference job was created.

', 'BatchInferenceJob$lastUpdatedDateTime' => '

The time at which the batch inference job was last updated.

', 'BatchInferenceJobSummary$creationDateTime' => '

The time at which the batch inference job was created.

', 'BatchInferenceJobSummary$lastUpdatedDateTime' => '

The time at which the batch inference job was last updated.

', 'BatchSegmentJob$creationDateTime' => '

The time at which the batch segment job was created.

', 'BatchSegmentJob$lastUpdatedDateTime' => '

The time at which the batch segment job last updated.

', 'BatchSegmentJobSummary$creationDateTime' => '

The time at which the batch segment job was created.

', 'BatchSegmentJobSummary$lastUpdatedDateTime' => '

The time at which the batch segment job was last updated.

', 'Campaign$creationDateTime' => '

The date and time (in Unix format) that the campaign was created.

', 'Campaign$lastUpdatedDateTime' => '

The date and time (in Unix format) that the campaign was last updated.

', 'CampaignSummary$creationDateTime' => '

The date and time (in Unix time) that the campaign was created.

', 'CampaignSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the campaign was last updated.

', 'CampaignUpdateSummary$creationDateTime' => '

The date and time (in Unix time) that the campaign update was created.

', 'CampaignUpdateSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the campaign update was last updated.

', 'DataDeletionJob$creationDateTime' => '

The creation date and time (in Unix time) of the data deletion job.

', 'DataDeletionJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the data deletion job was last updated.

', 'DataDeletionJobSummary$creationDateTime' => '

The creation date and time (in Unix time) of the data deletion job.

', 'DataDeletionJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) the data deletion job was last updated.

', 'Dataset$creationDateTime' => '

The creation date and time (in Unix time) of the dataset.

', 'Dataset$lastUpdatedDateTime' => '

A time stamp that shows when the dataset was updated.

', 'DatasetExportJob$creationDateTime' => '

The creation date and time (in Unix time) of the dataset export job.

', 'DatasetExportJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the status of the dataset export job was last updated.

', 'DatasetExportJobSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset export job was created.

', 'DatasetExportJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset export job status was last updated.

', 'DatasetGroup$creationDateTime' => '

The creation date and time (in Unix time) of the dataset group.

', 'DatasetGroup$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the dataset group.

', 'DatasetGroupSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset group was created.

', 'DatasetGroupSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset group was last updated.

', 'DatasetImportJob$creationDateTime' => '

The creation date and time (in Unix time) of the dataset import job.

', 'DatasetImportJob$lastUpdatedDateTime' => '

The date and time (in Unix time) the dataset was last updated.

', 'DatasetImportJobSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset import job was created.

', 'DatasetImportJobSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset import job status was last updated.

', 'DatasetSchema$creationDateTime' => '

The date and time (in Unix time) that the schema was created.

', 'DatasetSchema$lastUpdatedDateTime' => '

The date and time (in Unix time) that the schema was last updated.

', 'DatasetSchemaSummary$creationDateTime' => '

The date and time (in Unix time) that the schema was created.

', 'DatasetSchemaSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the schema was last updated.

', 'DatasetSummary$creationDateTime' => '

The date and time (in Unix time) that the dataset was created.

', 'DatasetSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the dataset was last updated.

', 'DatasetUpdateSummary$creationDateTime' => '

The creation date and time (in Unix time) of the dataset update.

', 'DatasetUpdateSummary$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the dataset.

', 'EventTracker$creationDateTime' => '

The date and time (in Unix format) that the event tracker was created.

', 'EventTracker$lastUpdatedDateTime' => '

The date and time (in Unix time) that the event tracker was last updated.

', 'EventTrackerSummary$creationDateTime' => '

The date and time (in Unix time) that the event tracker was created.

', 'EventTrackerSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the event tracker was last updated.

', 'FeatureTransformation$creationDateTime' => '

The creation date and time (in Unix time) of the feature transformation.

', 'FeatureTransformation$lastUpdatedDateTime' => '

The last update date and time (in Unix time) of the feature transformation.

', 'Filter$creationDateTime' => '

The time at which the filter was created.

', 'Filter$lastUpdatedDateTime' => '

The time at which the filter was last updated.

', 'FilterSummary$creationDateTime' => '

The time at which the filter was created.

', 'FilterSummary$lastUpdatedDateTime' => '

The time at which the filter was last updated.

', 'MetricAttribution$creationDateTime' => '

The metric attribution\'s creation date time.

', 'MetricAttribution$lastUpdatedDateTime' => '

The metric attribution\'s last updated date time.

', 'MetricAttributionSummary$creationDateTime' => '

The metric attribution\'s creation date time.

', 'MetricAttributionSummary$lastUpdatedDateTime' => '

The metric attribution\'s last updated date time.

', 'Recipe$creationDateTime' => '

The date and time (in Unix format) that the recipe was created.

', 'Recipe$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recipe was last updated.

', 'RecipeSummary$creationDateTime' => '

The date and time (in Unix time) that the recipe was created.

', 'RecipeSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the recipe was last updated.

', 'Recommender$creationDateTime' => '

The date and time (in Unix format) that the recommender was created.

', 'Recommender$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recommender was last updated.

', 'RecommenderSummary$creationDateTime' => '

The date and time (in Unix format) that the recommender was created.

', 'RecommenderSummary$lastUpdatedDateTime' => '

The date and time (in Unix format) that the recommender was last updated.

', 'RecommenderUpdateSummary$creationDateTime' => '

The date and time (in Unix format) that the recommender update was created.

', 'RecommenderUpdateSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the recommender update was last updated.

', 'Solution$creationDateTime' => '

The creation date and time (in Unix time) of the solution.

', 'Solution$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionSummary$creationDateTime' => '

The date and time (in Unix time) that the solution was created.

', 'SolutionSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionUpdateSummary$creationDateTime' => '

The date and time (in Unix format) that the solution update was created.

', 'SolutionUpdateSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution update was last updated.

', 'SolutionVersion$creationDateTime' => '

The date and time (in Unix time) that this version of the solution was created.

', 'SolutionVersion$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution was last updated.

', 'SolutionVersionSummary$creationDateTime' => '

The date and time (in Unix time) that this version of a solution was created.

', 'SolutionVersionSummary$lastUpdatedDateTime' => '

The date and time (in Unix time) that the solution version was last updated.

', ], ], 'DefaultCategoricalHyperParameterRange' => [ 'base' => '

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultCategoricalHyperParameterRanges$member' => NULL, ], ], 'DefaultCategoricalHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$categoricalHyperParameterRanges' => '

The categorical hyperparameters and their default ranges.

', ], ], 'DefaultContinuousHyperParameterRange' => [ 'base' => '

Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultContinuousHyperParameterRanges$member' => NULL, ], ], 'DefaultContinuousHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$continuousHyperParameterRanges' => '

The continuous hyperparameters and their default ranges.

', ], ], 'DefaultHyperParameterRanges' => [ 'base' => '

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

', 'refs' => [ 'Algorithm$defaultHyperParameterRanges' => '

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', ], ], 'DefaultIntegerHyperParameterRange' => [ 'base' => '

Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

', 'refs' => [ 'DefaultIntegerHyperParameterRanges$member' => NULL, ], ], 'DefaultIntegerHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'DefaultHyperParameterRanges$integerHyperParameterRanges' => '

The integer-valued hyperparameters and their default ranges.

', ], ], 'DeleteCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchInferenceJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchInferenceJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchSegmentJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBatchSegmentJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataDeletionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataDeletionJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventTrackerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventTrackerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureTransformationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureTransformationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFilterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFilterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecipeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecipeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSolutionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'Recipe$description' => '

The description of the recipe.

', ], ], 'DockerURI' => [ 'base' => NULL, 'refs' => [ 'AlgorithmImage$dockerURI' => '

The URI of the Docker container for the algorithm image.

', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetGroupRequest$domain' => '

The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don\'t specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.

', 'CreateDatasetGroupResponse$domain' => '

The domain for the new Domain dataset group.

', 'CreateSchemaRequest$domain' => '

The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

', 'DatasetGroup$domain' => '

The domain of a Domain dataset group.

', 'DatasetGroupSummary$domain' => '

The domain of a Domain dataset group.

', 'DatasetSchema$domain' => '

The domain of a schema that you created for a dataset in a Domain dataset group.

', 'DatasetSchemaSummary$domain' => '

The domain of a schema that you created for a dataset in a Domain dataset group.

', 'ListRecipesRequest$domain' => '

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don\'t specify a domain, all recipes are returned.

', 'RecipeSummary$domain' => '

The domain of the recipe (if the recipe is a Domain dataset group use case).

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InvalidInputException$message' => NULL, 'InvalidNextTokenException$message' => NULL, 'LimitExceededException$message' => NULL, 'ResourceAlreadyExistsException$message' => NULL, 'ResourceInUseException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'TooManyTagKeysException$message' => NULL, 'TooManyTagsException$message' => NULL, ], ], 'EventTracker' => [ 'base' => '

Provides information about an event tracker.

', 'refs' => [ 'DescribeEventTrackerResponse$eventTracker' => '

An object that describes the event tracker.

', ], ], 'EventTrackerSummary' => [ 'base' => '

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

', 'refs' => [ 'EventTrackers$member' => NULL, ], ], 'EventTrackers' => [ 'base' => NULL, 'refs' => [ 'ListEventTrackersResponse$eventTrackers' => '

A list of event trackers.

', ], ], 'EventType' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$eventType' => '

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, \'click\' or \'like\') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

', 'MetricAttribute$eventType' => '

The metric\'s event type.

', 'Solution$eventType' => '

The event type (for example, \'click\' or \'like\') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

', 'SolutionVersion$eventType' => '

The event type (for example, \'click\' or \'like\') that is used for training the model.

', ], ], 'EventValueThreshold' => [ 'base' => NULL, 'refs' => [ 'SolutionConfig$eventValueThreshold' => '

Only events with a value greater than or equal to this threshold are used for training a model.

', ], ], 'ExcludedDatasetColumns' => [ 'base' => NULL, 'refs' => [ 'TrainingDataConfig$excludedDatasetColumns' => '

Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$failureReason' => '

If the batch inference job failed, the reason for the failure.

', 'BatchInferenceJobSummary$failureReason' => '

If the batch inference job failed, the reason for the failure.

', 'BatchSegmentJob$failureReason' => '

If the batch segment job failed, the reason for the failure.

', 'BatchSegmentJobSummary$failureReason' => '

If the batch segment job failed, the reason for the failure.

', 'Campaign$failureReason' => '

If a campaign fails, the reason behind the failure.

', 'CampaignSummary$failureReason' => '

If a campaign fails, the reason behind the failure.

', 'CampaignUpdateSummary$failureReason' => '

If a campaign update fails, the reason behind the failure.

', 'DataDeletionJob$failureReason' => '

If a data deletion job fails, provides the reason why.

', 'DataDeletionJobSummary$failureReason' => '

If a data deletion job fails, provides the reason why.

', 'DatasetExportJob$failureReason' => '

If a dataset export job fails, provides the reason why.

', 'DatasetExportJobSummary$failureReason' => '

If a dataset export job fails, the reason behind the failure.

', 'DatasetGroup$failureReason' => '

If creating a dataset group fails, provides the reason why.

', 'DatasetGroupSummary$failureReason' => '

If creating a dataset group fails, the reason behind the failure.

', 'DatasetImportJob$failureReason' => '

If a dataset import job fails, provides the reason why.

', 'DatasetImportJobSummary$failureReason' => '

If a dataset import job fails, the reason behind the failure.

', 'DatasetUpdateSummary$failureReason' => '

If updating a dataset fails, provides the reason why.

', 'Filter$failureReason' => '

If the filter failed, the reason for its failure.

', 'FilterSummary$failureReason' => '

If the filter failed, the reason for the failure.

', 'MetricAttribution$failureReason' => '

The metric attribution\'s failure reason.

', 'MetricAttributionSummary$failureReason' => '

The metric attribution\'s failure reason.

', 'Recommender$failureReason' => '

If a recommender fails, the reason behind the failure.

', 'RecommenderUpdateSummary$failureReason' => '

If a recommender update fails, the reason behind the failure.

', 'SolutionUpdateSummary$failureReason' => '

If a solution update fails, the reason behind the failure.

', 'SolutionVersion$failureReason' => '

If training a solution version fails, the reason for the failure.

', 'SolutionVersionSummary$failureReason' => '

If a solution version fails, the reason behind the failure.

', ], ], 'FeatureTransformation' => [ 'base' => '

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

', 'refs' => [ 'DescribeFeatureTransformationResponse$featureTransformation' => '

A listing of the FeatureTransformation properties.

', ], ], 'FeatureTransformationParameters' => [ 'base' => NULL, 'refs' => [ 'SolutionConfig$featureTransformationParameters' => '

Lists the feature transformation parameters.

', ], ], 'FeaturizationParameters' => [ 'base' => NULL, 'refs' => [ 'FeatureTransformation$defaultParameters' => '

Provides the default parameters for feature transformation.

', ], ], 'FieldsForThemeGeneration' => [ 'base' => '

A string to string map of the configuration details for theme generation.

', 'refs' => [ 'ThemeGenerationConfig$fieldsForThemeGeneration' => '

Fields used to generate descriptive themes for a batch inference job.

', ], ], 'Filter' => [ 'base' => '

Contains information on a recommendation filter, including its ARN, status, and filter expression.

', 'refs' => [ 'DescribeFilterResponse$filter' => '

The filter\'s details.

', ], ], 'FilterExpression' => [ 'base' => NULL, 'refs' => [ 'CreateFilterRequest$filterExpression' => '

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

', 'Filter$filterExpression' => '

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

', ], ], 'FilterSummary' => [ 'base' => '

A short summary of a filter\'s attributes.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'ListFiltersResponse$Filters' => '

A list of returned filters.

', ], ], 'GetSolutionMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSolutionMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'HPOConfig' => [ 'base' => '

Describes the properties for hyperparameter optimization (HPO).

', 'refs' => [ 'SolutionConfig$hpoConfig' => '

Describes the properties for hyperparameter optimization (HPO).

', ], ], 'HPOObjective' => [ 'base' => '

The metric to optimize during hyperparameter optimization (HPO).

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', 'refs' => [ 'HPOConfig$hpoObjective' => '

The metric to optimize during HPO.

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', ], ], 'HPOObjectiveType' => [ 'base' => NULL, 'refs' => [ 'HPOObjective$type' => '

The type of the metric. Valid values are Maximize and Minimize.

', ], ], 'HPOResource' => [ 'base' => NULL, 'refs' => [ 'HPOResourceConfig$maxNumberOfTrainingJobs' => '

The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

', 'HPOResourceConfig$maxParallelTrainingJobs' => '

The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

', ], ], 'HPOResourceConfig' => [ 'base' => '

Describes the resource configuration for hyperparameter optimization (HPO).

', 'refs' => [ 'HPOConfig$hpoResourceConfig' => '

Describes the resource configuration for HPO.

', ], ], 'HyperParameterRanges' => [ 'base' => '

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

', 'refs' => [ 'HPOConfig$algorithmHyperParameterRanges' => '

The hyperparameters and their allowable ranges.

', ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'Algorithm$defaultHyperParameters' => '

Specifies the default hyperparameters.

', 'BatchInferenceJobConfig$itemExplorationConfig' => '

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.

', 'CampaignConfig$itemExplorationConfig' => '

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

', 'RecommenderConfig$itemExplorationConfig' => '

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

', 'SolutionConfig$algorithmHyperParameters' => '

Lists the algorithm hyperparameters and their values.

', 'TunedHPOParams$algorithmHyperParameters' => '

A list of the hyperparameter values of the best performing model.

', ], ], 'ImportMode' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetImportJobRequest$importMode' => '

Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven\'t imported bulk records into the dataset previously, you can only specify FULL.

', 'DatasetImportJob$importMode' => '

The import mode used by the dataset import job to import new records.

', 'DatasetImportJobSummary$importMode' => '

The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.

', ], ], 'IngestionMode' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetExportJobRequest$ingestionMode' => '

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

', 'DatasetExportJob$ingestionMode' => '

The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DataDeletionJob$numDeleted' => '

The number of records deleted by a COMPLETED job.

', ], ], 'IntegerHyperParameterRange' => [ 'base' => '

Provides the name and range of an integer-valued hyperparameter.

', 'refs' => [ 'IntegerHyperParameterRanges$member' => NULL, ], ], 'IntegerHyperParameterRanges' => [ 'base' => NULL, 'refs' => [ 'HyperParameterRanges$integerHyperParameterRanges' => '

The integer-valued hyperparameters and their ranges.

', ], ], 'IntegerMaxValue' => [ 'base' => NULL, 'refs' => [ 'DefaultIntegerHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', 'IntegerHyperParameterRange$maxValue' => '

The maximum allowable value for the hyperparameter.

', ], ], 'IntegerMinValue' => [ 'base' => NULL, 'refs' => [ 'DefaultIntegerHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', 'IntegerHyperParameterRange$minValue' => '

The minimum allowable value for the hyperparameter.

', ], ], 'InvalidInputException' => [ 'base' => '

Provide a valid value for the field or parameter.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The token is not valid.

', 'refs' => [], ], 'ItemAttribute' => [ 'base' => NULL, 'refs' => [ 'OptimizationObjective$itemAttribute' => '

The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetGroupRequest$kmsKeyArn' => '

The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.

', 'DatasetGroup$kmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

', 'S3DataConfig$kmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

', ], ], 'LimitExceededException' => [ 'base' => '

The limit on the number of requests per second has been exceeded.

', 'refs' => [], ], 'ListBatchInferenceJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchInferenceJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchSegmentJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBatchSegmentJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCampaignsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCampaignsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataDeletionJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataDeletionJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEventTrackersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventTrackersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFiltersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFiltersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMetricAttributionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecipesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecipesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecommendersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSolutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsRequest$maxResults' => '

The maximum number of batch inference job results to return in each page. The default value is 100.

', 'ListBatchSegmentJobsRequest$maxResults' => '

The maximum number of batch segment job results to return in each page. The default value is 100.

', 'ListCampaignsRequest$maxResults' => '

The maximum number of campaigns to return.

', 'ListDataDeletionJobsRequest$maxResults' => '

The maximum number of data deletion jobs to return.

', 'ListDatasetExportJobsRequest$maxResults' => '

The maximum number of dataset export jobs to return.

', 'ListDatasetGroupsRequest$maxResults' => '

The maximum number of dataset groups to return.

', 'ListDatasetImportJobsRequest$maxResults' => '

The maximum number of dataset import jobs to return.

', 'ListDatasetsRequest$maxResults' => '

The maximum number of datasets to return.

', 'ListEventTrackersRequest$maxResults' => '

The maximum number of event trackers to return.

', 'ListFiltersRequest$maxResults' => '

The maximum number of filters to return.

', 'ListMetricAttributionMetricsRequest$maxResults' => '

The maximum number of metrics to return in one page of results.

', 'ListMetricAttributionsRequest$maxResults' => '

The maximum number of metric attributions to return in one page of results.

', 'ListRecipesRequest$maxResults' => '

The maximum number of recipes to return.

', 'ListRecommendersRequest$maxResults' => '

The maximum number of recommenders to return.

', 'ListSchemasRequest$maxResults' => '

The maximum number of schemas to return.

', 'ListSolutionVersionsRequest$maxResults' => '

The maximum number of solution versions to return.

', 'ListSolutionsRequest$maxResults' => '

The maximum number of solutions to return.

', ], ], 'MetricAttribute' => [ 'base' => '

Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

', 'refs' => [ 'MetricAttributes$member' => NULL, ], ], 'MetricAttributes' => [ 'base' => NULL, 'refs' => [ 'CreateMetricAttributionRequest$metrics' => '

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

', 'ListMetricAttributionMetricsResponse$metrics' => '

The metrics for the specified metric attribution.

', 'UpdateMetricAttributionRequest$addMetrics' => '

Add new metric attributes to the metric attribution.

', ], ], 'MetricAttributesNamesList' => [ 'base' => NULL, 'refs' => [ 'UpdateMetricAttributionRequest$removeMetrics' => '

Remove metric attributes from the metric attribution.

', ], ], 'MetricAttribution' => [ 'base' => '

Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

', 'refs' => [ 'DescribeMetricAttributionResponse$metricAttribution' => '

The details of the metric attribution.

', ], ], 'MetricAttributionOutput' => [ 'base' => '

The output configuration details for a metric attribution.

', 'refs' => [ 'CreateMetricAttributionRequest$metricsOutputConfig' => '

The output configuration details for the metric attribution.

', 'MetricAttribution$metricsOutputConfig' => '

The metric attribution\'s output configuration.

', 'UpdateMetricAttributionRequest$metricsOutputConfig' => '

An output config for the metric attribution.

', ], ], 'MetricAttributionSummary' => [ 'base' => '

Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.

', 'refs' => [ 'MetricAttributions$member' => NULL, ], ], 'MetricAttributions' => [ 'base' => NULL, 'refs' => [ 'ListMetricAttributionsResponse$metricAttributions' => '

The list of metric attributions.

', ], ], 'MetricExpression' => [ 'base' => NULL, 'refs' => [ 'MetricAttribute$expression' => '

The attribute\'s expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'AutoMLConfig$metricName' => '

The metric to optimize.

', 'HPOObjective$metricName' => '

The name of the metric.

', 'MetricAttribute$metricName' => '

The metric\'s name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

', 'MetricAttributesNamesList$member' => NULL, 'Metrics$key' => NULL, ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'HPOObjective$metricRegex' => '

A regular expression for finding the metric in the training job logs.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'Metrics$value' => NULL, ], ], 'Metrics' => [ 'base' => NULL, 'refs' => [ 'GetSolutionMetricsResponse$metrics' => '

The metrics for the solution version. For more information, see Evaluating a solution version with metrics .

', 'Recommender$modelMetrics' => '

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Algorithm$name' => '

The name of the algorithm.

', 'AlgorithmImage$name' => '

The name of the algorithm image.

', 'BatchInferenceJob$jobName' => '

The name of the batch inference job.

', 'BatchInferenceJobSummary$jobName' => '

The name of the batch inference job.

', 'BatchSegmentJob$jobName' => '

The name of the batch segment job.

', 'BatchSegmentJobSummary$jobName' => '

The name of the batch segment job.

', 'Campaign$name' => '

The name of the campaign.

', 'CampaignSummary$name' => '

The name of the campaign.

', 'CreateBatchInferenceJobRequest$jobName' => '

The name of the batch inference job to create.

', 'CreateBatchSegmentJobRequest$jobName' => '

The name of the batch segment job to create.

', 'CreateCampaignRequest$name' => '

A name for the new campaign. The campaign name must be unique within your account.

', 'CreateDataDeletionJobRequest$jobName' => '

The name for the data deletion job.

', 'CreateDatasetExportJobRequest$jobName' => '

The name for the dataset export job.

', 'CreateDatasetGroupRequest$name' => '

The name for the new dataset group.

', 'CreateDatasetImportJobRequest$jobName' => '

The name for the dataset import job.

', 'CreateDatasetRequest$name' => '

The name for the dataset.

', 'CreateEventTrackerRequest$name' => '

The name for the event tracker.

', 'CreateFilterRequest$name' => '

The name of the filter to create.

', 'CreateMetricAttributionRequest$name' => '

A name for the metric attribution.

', 'CreateRecommenderRequest$name' => '

The name of the recommender.

', 'CreateSchemaRequest$name' => '

The name for the schema.

', 'CreateSolutionRequest$name' => '

The name for the solution.

', 'CreateSolutionVersionRequest$name' => '

The name of the solution version.

', 'DataDeletionJob$jobName' => '

The name of the data deletion job.

', 'DataDeletionJobSummary$jobName' => '

The name of the data deletion job.

', 'Dataset$name' => '

The name of the dataset.

', 'DatasetExportJob$jobName' => '

The name of the export job.

', 'DatasetExportJobSummary$jobName' => '

The name of the dataset export job.

', 'DatasetGroup$name' => '

The name of the dataset group.

', 'DatasetGroupSummary$name' => '

The name of the dataset group.

', 'DatasetImportJob$jobName' => '

The name of the import job.

', 'DatasetImportJobSummary$jobName' => '

The name of the dataset import job.

', 'DatasetSchema$name' => '

The name of the schema.

', 'DatasetSchemaSummary$name' => '

The name of the schema.

', 'DatasetSummary$name' => '

The name of the dataset.

', 'EventTracker$name' => '

The name of the event tracker.

', 'EventTrackerSummary$name' => '

The name of the event tracker.

', 'FeatureTransformation$name' => '

The name of the feature transformation.

', 'Filter$name' => '

The name of the filter.

', 'FilterSummary$name' => '

The name of the filter.

', 'MetricAttribution$name' => '

The metric attribution\'s name.

', 'MetricAttributionSummary$name' => '

The name of the metric attribution.

', 'Recipe$name' => '

The name of the recipe.

', 'RecipeSummary$name' => '

The name of the recipe.

', 'Recommender$name' => '

The name of the recommender.

', 'RecommenderSummary$name' => '

The name of the recommender.

', 'Solution$name' => '

The name of the solution.

', 'SolutionSummary$name' => '

The name of the solution.

', 'SolutionVersion$name' => '

The name of the solution version.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListBatchInferenceJobsRequest$nextToken' => '

The token to request the next page of results.

', 'ListBatchInferenceJobsResponse$nextToken' => '

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

', 'ListBatchSegmentJobsRequest$nextToken' => '

The token to request the next page of results.

', 'ListBatchSegmentJobsResponse$nextToken' => '

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

', 'ListCampaignsRequest$nextToken' => '

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

', 'ListCampaignsResponse$nextToken' => '

A token for getting the next set of campaigns (if they exist).

', 'ListDataDeletionJobsRequest$nextToken' => '

A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).

', 'ListDataDeletionJobsResponse$nextToken' => '

A token for getting the next set of data deletion jobs (if they exist).

', 'ListDatasetExportJobsRequest$nextToken' => '

A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

', 'ListDatasetExportJobsResponse$nextToken' => '

A token for getting the next set of dataset export jobs (if they exist).

', 'ListDatasetGroupsRequest$nextToken' => '

A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

', 'ListDatasetGroupsResponse$nextToken' => '

A token for getting the next set of dataset groups (if they exist).

', 'ListDatasetImportJobsRequest$nextToken' => '

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetImportJobsResponse$nextToken' => '

A token for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetsRequest$nextToken' => '

A token returned from the previous call to ListDatasets for getting the next set of dataset import jobs (if they exist).

', 'ListDatasetsResponse$nextToken' => '

A token for getting the next set of datasets (if they exist).

', 'ListEventTrackersRequest$nextToken' => '

A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

', 'ListEventTrackersResponse$nextToken' => '

A token for getting the next set of event trackers (if they exist).

', 'ListFiltersRequest$nextToken' => '

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

', 'ListFiltersResponse$nextToken' => '

A token for getting the next set of filters (if they exist).

', 'ListMetricAttributionMetricsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListMetricAttributionMetricsResponse$nextToken' => '

Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.

', 'ListMetricAttributionsRequest$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListMetricAttributionsResponse$nextToken' => '

Specify the pagination token from a previous request to retrieve the next page of results.

', 'ListRecipesRequest$nextToken' => '

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

', 'ListRecipesResponse$nextToken' => '

A token for getting the next set of recipes.

', 'ListRecommendersRequest$nextToken' => '

A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

', 'ListRecommendersResponse$nextToken' => '

A token for getting the next set of recommenders (if they exist).

', 'ListSchemasRequest$nextToken' => '

A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

', 'ListSchemasResponse$nextToken' => '

A token used to get the next set of schemas (if they exist).

', 'ListSolutionVersionsRequest$nextToken' => '

A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

', 'ListSolutionVersionsResponse$nextToken' => '

A token for getting the next set of solution versions (if they exist).

', 'ListSolutionsRequest$nextToken' => '

A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

', 'ListSolutionsResponse$nextToken' => '

A token for getting the next set of solutions (if they exist).

', ], ], 'NumBatchResults' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$numResults' => '

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

', 'BatchSegmentJob$numResults' => '

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

', 'CreateBatchInferenceJobRequest$numResults' => '

The number of recommendations to retrieve.

', 'CreateBatchSegmentJobRequest$numResults' => '

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

', ], ], 'ObjectiveSensitivity' => [ 'base' => NULL, 'refs' => [ 'OptimizationObjective$objectiveSensitivity' => '

Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

', ], ], 'OptimizationObjective' => [ 'base' => '

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

', 'refs' => [ 'SolutionConfig$optimizationObjective' => '

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'CategoricalHyperParameterRange$name' => '

The name of the hyperparameter.

', 'ContinuousHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultCategoricalHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultContinuousHyperParameterRange$name' => '

The name of the hyperparameter.

', 'DefaultIntegerHyperParameterRange$name' => '

The name of the hyperparameter.

', 'FeatureTransformationParameters$key' => NULL, 'FeaturizationParameters$key' => NULL, 'HyperParameters$key' => NULL, 'IntegerHyperParameterRange$name' => '

The name of the hyperparameter.

', 'ResourceConfig$key' => NULL, ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureTransformationParameters$value' => NULL, 'FeaturizationParameters$value' => NULL, 'HyperParameters$value' => NULL, 'ResourceConfig$value' => NULL, ], ], 'PerformAutoML' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$performAutoML' => '

We don\'t recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

', 'Solution$performAutoML' => '

We don\'t recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

', 'SolutionVersion$performAutoML' => '

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

', ], ], 'PerformAutoTraining' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionRequest$performAutoTraining' => '

Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

After training starts, you can get the solution version\'s Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

', 'Solution$performAutoTraining' => '

Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.

For more information about auto training, see Creating and configuring a solution.

', 'SolutionUpdateSummary$performAutoTraining' => '

Whether the solution automatically creates solution versions.

', 'UpdateSolutionRequest$performAutoTraining' => '

Whether the solution uses automatic training to create new solution versions (trained models). You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration.

If you turn on automatic training, the first automatic training starts within one hour after the solution update completes. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information about automatic training, see Configuring automatic training.

After training starts, you can get the solution version\'s Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

', ], ], 'PerformHPO' => [ 'base' => NULL, 'refs' => [ 'Solution$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

', 'SolutionVersion$performHPO' => '

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

', ], ], 'Recipe' => [ 'base' => '

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.

', 'refs' => [ 'DescribeRecipeResponse$recipe' => '

An object that describes the recipe.

', ], ], 'RecipeProvider' => [ 'base' => NULL, 'refs' => [ 'ListRecipesRequest$recipeProvider' => '

The default is SERVICE.

', ], ], 'RecipeSummary' => [ 'base' => '

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

', 'refs' => [ 'Recipes$member' => NULL, ], ], 'RecipeType' => [ 'base' => NULL, 'refs' => [ 'Recipe$recipeType' => '

One of the following values:

', ], ], 'Recipes' => [ 'base' => NULL, 'refs' => [ 'ListRecipesResponse$recipes' => '

The list of available recipes.

', ], ], 'Recommender' => [ 'base' => '

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

', 'refs' => [ 'DescribeRecommenderResponse$recommender' => '

The properties of the recommender.

', ], ], 'RecommenderConfig' => [ 'base' => '

The configuration details of the recommender.

', 'refs' => [ 'CreateRecommenderRequest$recommenderConfig' => '

The configuration details of the recommender.

', 'Recommender$recommenderConfig' => '

The configuration details of the recommender.

', 'RecommenderSummary$recommenderConfig' => '

The configuration details of the recommender.

', 'RecommenderUpdateSummary$recommenderConfig' => '

The configuration details of the recommender update.

', 'UpdateRecommenderRequest$recommenderConfig' => '

The configuration details of the recommender.

', ], ], 'RecommenderSummary' => [ 'base' => '

Provides a summary of the properties of the recommender.

', 'refs' => [ 'Recommenders$member' => NULL, ], ], 'RecommenderUpdateSummary' => [ 'base' => '

Provides a summary of the properties of a recommender update. For a complete listing, call the DescribeRecommender API.

', 'refs' => [ 'Recommender$latestRecommenderUpdate' => '

Provides a summary of the latest updates to the recommender.

', ], ], 'Recommenders' => [ 'base' => NULL, 'refs' => [ 'ListRecommendersResponse$recommenders' => '

A list of the recommenders.

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

The specified resource already exists.

', 'refs' => [], ], 'ResourceConfig' => [ 'base' => NULL, 'refs' => [ 'Algorithm$defaultResourceConfig' => '

Specifies the default maximum number of training jobs and parallel training jobs.

', ], ], 'ResourceInUseException' => [ 'base' => '

The specified resource is in use.

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

Could not find the specified resource.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$roleArn' => '

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

', 'BatchSegmentJob$roleArn' => '

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

', 'CreateBatchInferenceJobRequest$roleArn' => '

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

', 'CreateBatchSegmentJobRequest$roleArn' => '

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

', 'CreateDataDeletionJobRequest$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

', 'CreateDatasetExportJobRequest$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

', 'CreateDatasetGroupRequest$roleArn' => '

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

', 'CreateDatasetImportJobRequest$roleArn' => '

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DataDeletionJob$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

', 'DatasetGroup$roleArn' => '

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

', 'MetricAttributionOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.

', ], ], 'S3DataConfig' => [ 'base' => '

The configuration details of an Amazon S3 input or output bucket.

', 'refs' => [ 'BatchInferenceJobInput$s3DataSource' => '

The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.

', 'BatchInferenceJobOutput$s3DataDestination' => '

Information on the Amazon S3 bucket in which the batch inference job\'s output is stored.

', 'BatchSegmentJobInput$s3DataSource' => NULL, 'BatchSegmentJobOutput$s3DataDestination' => NULL, 'DatasetExportJobOutput$s3DataDestination' => NULL, 'MetricAttributionOutput$s3DataDestination' => NULL, ], ], 'S3Location' => [ 'base' => NULL, 'refs' => [ 'DataSource$dataLocation' => '

For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.

For example:

s3://bucket-name/folder-name/fileName.csv

If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder name:

s3://bucket-name/folder-name/

', 'S3DataConfig$path' => '

The file path of the Amazon S3 bucket.

', ], ], 'SchedulingExpression' => [ 'base' => NULL, 'refs' => [ 'AutoTrainingConfig$schedulingExpression' => '

Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

For more information about auto training, see Creating and configuring a solution.

', ], ], 'Schemas' => [ 'base' => NULL, 'refs' => [ 'ListSchemasResponse$schemas' => '

A list of schemas.

', ], ], 'Solution' => [ 'base' => '

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.

', 'refs' => [ 'DescribeSolutionResponse$solution' => '

An object that describes the solution.

', ], ], 'SolutionConfig' => [ 'base' => '

Describes the configuration properties for the solution.

', 'refs' => [ 'CreateSolutionRequest$solutionConfig' => '

The configuration properties for the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn\'t support configuring the hpoObjective at this time.

', 'Solution$solutionConfig' => '

Describes the configuration properties for the solution.

', 'SolutionVersion$solutionConfig' => '

Describes the configuration properties for the solution.

', ], ], 'SolutionSummary' => [ 'base' => '

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.

', 'refs' => [ 'Solutions$member' => NULL, ], ], 'SolutionUpdateConfig' => [ 'base' => '

The configuration details of the solution update.

', 'refs' => [ 'SolutionUpdateSummary$solutionUpdateConfig' => '

The configuration details of the solution.

', 'UpdateSolutionRequest$solutionUpdateConfig' => '

The new configuration details of the solution.

', ], ], 'SolutionUpdateSummary' => [ 'base' => '

Provides a summary of the properties of a solution update. For a complete listing, call the DescribeSolution API.

', 'refs' => [ 'Solution$latestSolutionUpdate' => '

Provides a summary of the latest updates to the solution.

', ], ], 'SolutionVersion' => [ 'base' => '

An object that provides information about a specific version of a Solution in a Custom dataset group.

', 'refs' => [ 'DescribeSolutionVersionResponse$solutionVersion' => '

The solution version.

', ], ], 'SolutionVersionSummary' => [ 'base' => '

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

', 'refs' => [ 'Solution$latestSolutionVersion' => '

Describes the latest version of the solution, including the status and the ARN.

', 'SolutionVersions$member' => NULL, ], ], 'SolutionVersions' => [ 'base' => NULL, 'refs' => [ 'ListSolutionVersionsResponse$solutionVersions' => '

A list of solution versions describing the version properties.

', ], ], 'Solutions' => [ 'base' => NULL, 'refs' => [ 'ListSolutionsResponse$solutions' => '

A list of the current solutions.

', ], ], 'StartRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'BatchInferenceJob$status' => '

The status of the batch inference job. The status is one of the following values:

', 'BatchInferenceJobSummary$status' => '

The status of the batch inference job. The status is one of the following values:

', 'BatchSegmentJob$status' => '

The status of the batch segment job. The status is one of the following values:

', 'BatchSegmentJobSummary$status' => '

The status of the batch segment job. The status is one of the following values:

', 'Campaign$status' => '

The status of the campaign.

A campaign can be in one of the following states:

', 'CampaignSummary$status' => '

The status of the campaign.

A campaign can be in one of the following states:

', 'CampaignUpdateSummary$status' => '

The status of the campaign update.

A campaign update can be in one of the following states:

', 'DataDeletionJob$status' => '

The status of the data deletion job.

A data deletion job can have one of the following statuses:

', 'DataDeletionJobSummary$status' => '

The status of the data deletion job.

A data deletion job can have one of the following statuses:

', 'Dataset$status' => '

The status of the dataset.

A dataset can be in one of the following states:

', 'DatasetExportJob$status' => '

The status of the dataset export job.

A dataset export job can be in one of the following states:

', 'DatasetExportJobSummary$status' => '

The status of the dataset export job.

A dataset export job can be in one of the following states:

', 'DatasetGroup$status' => '

The current status of the dataset group.

A dataset group can be in one of the following states:

', 'DatasetGroupSummary$status' => '

The status of the dataset group.

A dataset group can be in one of the following states:

', 'DatasetImportJob$status' => '

The status of the dataset import job.

A dataset import job can be in one of the following states:

', 'DatasetImportJobSummary$status' => '

The status of the dataset import job.

A dataset import job can be in one of the following states:

', 'DatasetSummary$status' => '

The status of the dataset.

A dataset can be in one of the following states:

', 'DatasetUpdateSummary$status' => '

The status of the dataset update.

', 'EventTracker$status' => '

The status of the event tracker.

An event tracker can be in one of the following states:

', 'EventTrackerSummary$status' => '

The status of the event tracker.

An event tracker can be in one of the following states:

', 'FeatureTransformation$status' => '

The status of the feature transformation.

A feature transformation can be in one of the following states:

', 'Filter$status' => '

The status of the filter.

', 'FilterSummary$status' => '

The status of the filter.

', 'MetricAttribution$status' => '

The metric attribution\'s status.

', 'MetricAttributionSummary$status' => '

The metric attribution\'s status.

', 'Recipe$status' => '

The status of the recipe.

', 'RecipeSummary$status' => '

The status of the recipe.

', 'Recommender$status' => '

The status of the recommender.

A recommender can be in one of the following states:

', 'RecommenderSummary$status' => '

The status of the recommender. A recommender can be in one of the following states:

', 'RecommenderUpdateSummary$status' => '

The status of the recommender update. A recommender update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

', 'Solution$status' => '

The status of the solution.

A solution can be in one of the following states:

', 'SolutionSummary$status' => '

The status of the solution.

A solution can be in one of the following states:

', 'SolutionUpdateSummary$status' => '

The status of the solution update. A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

', 'SolutionVersion$status' => '

The status of the solution version.

A solution version can be in one of the following states:

', 'SolutionVersionSummary$status' => '

The status of the solution version.

A solution version can be in one of the following states:

', ], ], 'StopRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSolutionVersionCreationRequest' => [ 'base' => NULL, 'refs' => [], ], 'Tag' => [ 'base' => '

The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$tagKey' => '

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The keys of the tags to be removed.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$tagValue' => '

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateBatchInferenceJobRequest$tags' => '

A list of tags to apply to the batch inference job.

', 'CreateBatchSegmentJobRequest$tags' => '

A list of tags to apply to the batch segment job.

', 'CreateCampaignRequest$tags' => '

A list of tags to apply to the campaign.

', 'CreateDataDeletionJobRequest$tags' => '

A list of tags to apply to the data deletion job.

', 'CreateDatasetExportJobRequest$tags' => '

A list of tags to apply to the dataset export job.

', 'CreateDatasetGroupRequest$tags' => '

A list of tags to apply to the dataset group.

', 'CreateDatasetImportJobRequest$tags' => '

A list of tags to apply to the dataset import job.

', 'CreateDatasetRequest$tags' => '

A list of tags to apply to the dataset.

', 'CreateEventTrackerRequest$tags' => '

A list of tags to apply to the event tracker.

', 'CreateFilterRequest$tags' => '

A list of tags to apply to the filter.

', 'CreateRecommenderRequest$tags' => '

A list of tags to apply to the recommender.

', 'CreateSolutionRequest$tags' => '

A list of tags to apply to the solution.

', 'CreateSolutionVersionRequest$tags' => '

A list of tags to apply to the solution version.

', 'ListTagsForResourceResponse$tags' => '

The resource\'s tags.

', 'TagResourceRequest$tags' => '

Tags to apply to the resource. For more information see Tagging Amazon Personalize resources.

', ], ], 'ThemeGenerationConfig' => [ 'base' => '

The configuration details for generating themes with a batch inference job.

', 'refs' => [ 'BatchInferenceJob$themeGenerationConfig' => '

The job\'s theme generation settings.

', 'CreateBatchInferenceJobRequest$themeGenerationConfig' => '

For theme generation jobs, specify the name of the column in your Items dataset that contains each item\'s name.

', ], ], 'TooManyTagKeysException' => [ 'base' => '

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

', 'refs' => [], ], 'TooManyTagsException' => [ 'base' => '

You have exceeded the maximum number of tags you can apply to this resource.

', 'refs' => [], ], 'TrackingId' => [ 'base' => NULL, 'refs' => [ 'CreateEventTrackerResponse$trackingId' => '

The ID of the event tracker. Include this ID in requests to the PutEvents API.

', 'Dataset$trackingId' => '

The ID of the event tracker for an Action interactions dataset. You specify the tracker\'s ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

', 'EventTracker$trackingId' => '

The ID of the event tracker. Include this ID in requests to the PutEvents API.

', ], ], 'TrainingDataConfig' => [ 'base' => '

The training data configuration to use when creating a domain recommender or custom solution version (trained model).

', 'refs' => [ 'RecommenderConfig$trainingDataConfig' => '

Specifies the training data configuration to use when creating a domain recommender.

', 'SolutionConfig$trainingDataConfig' => '

Specifies the training data configuration to use when creating a custom solution version (trained model).

', ], ], 'TrainingHours' => [ 'base' => NULL, 'refs' => [ 'SolutionVersion$trainingHours' => '

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

', ], ], 'TrainingInputMode' => [ 'base' => NULL, 'refs' => [ 'Algorithm$trainingInputMode' => '

The training input mode.

', ], ], 'TrainingMode' => [ 'base' => NULL, 'refs' => [ 'CreateSolutionVersionRequest$trainingMode' => '

The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group.

If you use User-Personalization, you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the legacy HRNN-Coldstart recipe.

', 'SolutionVersion$trainingMode' => '

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

', 'SolutionVersionSummary$trainingMode' => '

The scope of training to be performed when creating the solution version. A FULL training considers all of the data in your dataset group. An UPDATE processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.

', ], ], 'TrainingType' => [ 'base' => NULL, 'refs' => [ 'SolutionVersion$trainingType' => '

Whether the solution version was created automatically or manually.

', 'SolutionVersionSummary$trainingType' => '

Whether the solution version was created automatically or manually.

', ], ], 'TransactionsPerSecond' => [ 'base' => NULL, 'refs' => [ 'Campaign$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', 'CampaignUpdateSummary$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

', 'CreateCampaignRequest$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', 'RecommenderConfig$minRecommendationRequestsPerSecond' => '

Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

', 'UpdateCampaignRequest$minProvisionedTPS' => '

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

', ], ], 'Tunable' => [ 'base' => NULL, 'refs' => [ 'DefaultCategoricalHyperParameterRange$isTunable' => '

Whether the hyperparameter is tunable.

', 'DefaultContinuousHyperParameterRange$isTunable' => '

Whether the hyperparameter is tunable.

', 'DefaultIntegerHyperParameterRange$isTunable' => '

Indicates whether the hyperparameter is tunable.

', ], ], 'TunedHPOParams' => [ 'base' => '

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.

', 'refs' => [ 'SolutionVersion$tunedHPOParams' => '

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCampaignRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCampaignResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDatasetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDatasetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMetricAttributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMetricAttributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRecommenderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRecommenderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSolutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSolutionResponse' => [ 'base' => NULL, 'refs' => [], ], ],]; diff --git a/src/data/quicksight/2018-04-01/api-2.json b/src/data/quicksight/2018-04-01/api-2.json index 440c69e23b..4922144f04 100644 --- a/src/data/quicksight/2018-04-01/api-2.json +++ b/src/data/quicksight/2018-04-01/api-2.json @@ -5010,7 +5010,7 @@ "members":{ "ColumnName":{"shape":"ColumnName"}, "ColumnId":{"shape":"ColumnId"}, - "Expression":{"shape":"Expression"} + "Expression":{"shape":"DataSetCalculatedFieldExpression"} } }, "CalculatedColumnList":{ @@ -5385,7 +5385,8 @@ "ColumnDescriptiveText":{ "type":"string", "max":500, - "min":0 + "min":0, + "sensitive":true }, "ColumnGroup":{ "type":"structure", @@ -7375,6 +7376,12 @@ "member":{"shape":"Arn"}, "max":100 }, + "DataSetCalculatedFieldExpression":{ + "type":"string", + "max":250000, + "min":1, + "sensitive":true + }, "DataSetConfiguration":{ "type":"structure", "members":{ diff --git a/src/data/quicksight/2018-04-01/api-2.json.php b/src/data/quicksight/2018-04-01/api-2.json.php index ed6bdd0099..8a244f976c 100644 --- a/src/data/quicksight/2018-04-01/api-2.json.php +++ b/src/data/quicksight/2018-04-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-04-01', 'endpointPrefix' => 'quicksight', 'jsonVersion' => '1.0', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon QuickSight', 'serviceId' => 'QuickSight', 'signatureVersion' => 'v4', 'uid' => 'quicksight-2018-04-01', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'BatchCreateTopicReviewedAnswer' => [ 'name' => 'BatchCreateTopicReviewedAnswer', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers', ], 'input' => [ 'shape' => 'BatchCreateTopicReviewedAnswerRequest', ], 'output' => [ 'shape' => 'BatchCreateTopicReviewedAnswerResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'BatchDeleteTopicReviewedAnswer' => [ 'name' => 'BatchDeleteTopicReviewedAnswer', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers', ], 'input' => [ 'shape' => 'BatchDeleteTopicReviewedAnswerRequest', ], 'output' => [ 'shape' => 'BatchDeleteTopicReviewedAnswerResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CancelIngestion' => [ 'name' => 'CancelIngestion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'CancelIngestionRequest', ], 'output' => [ 'shape' => 'CancelIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateAccountCustomization' => [ 'name' => 'CreateAccountCustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'CreateAccountCustomizationRequest', ], 'output' => [ 'shape' => 'CreateAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateAccountSubscription' => [ 'name' => 'CreateAccountSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'CreateAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'CreateAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateAnalysis' => [ 'name' => 'CreateAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'CreateAnalysisRequest', ], 'output' => [ 'shape' => 'CreateAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDashboard' => [ 'name' => 'CreateDashboard', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'CreateDashboardRequest', ], 'output' => [ 'shape' => 'CreateDashboardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDataSet' => [ 'name' => 'CreateDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets', ], 'input' => [ 'shape' => 'CreateDataSetRequest', ], 'output' => [ 'shape' => 'CreateDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sources', ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'CustomerManagedKeyUnavailableException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateFolder' => [ 'name' => 'CreateFolder', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'CreateFolderRequest', ], 'output' => [ 'shape' => 'CreateFolderResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateFolderMembership' => [ 'name' => 'CreateFolderMembership', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}', ], 'input' => [ 'shape' => 'CreateFolderMembershipRequest', ], 'output' => [ 'shape' => 'CreateFolderMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateGroupMembership' => [ 'name' => 'CreateGroupMembership', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'CreateGroupMembershipRequest', ], 'output' => [ 'shape' => 'CreateGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateIAMPolicyAssignment' => [ 'name' => 'CreateIAMPolicyAssignment', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/', ], 'input' => [ 'shape' => 'CreateIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'CreateIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateIngestion' => [ 'name' => 'CreateIngestion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'CreateIngestionRequest', ], 'output' => [ 'shape' => 'CreateIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateNamespace' => [ 'name' => 'CreateNamespace', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}', ], 'input' => [ 'shape' => 'CreateNamespaceRequest', ], 'output' => [ 'shape' => 'CreateNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateRefreshSchedule' => [ 'name' => 'CreateRefreshSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'CreateRefreshScheduleRequest', ], 'output' => [ 'shape' => 'CreateRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateRoleMembership' => [ 'name' => 'CreateRoleMembership', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}', ], 'input' => [ 'shape' => 'CreateRoleMembershipRequest', ], 'output' => [ 'shape' => 'CreateRoleMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateTemplate' => [ 'name' => 'CreateTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'CreateTemplateRequest', ], 'output' => [ 'shape' => 'CreateTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTemplateAlias' => [ 'name' => 'CreateTemplateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'CreateTemplateAliasRequest', ], 'output' => [ 'shape' => 'CreateTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTheme' => [ 'name' => 'CreateTheme', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'CreateThemeRequest', ], 'output' => [ 'shape' => 'CreateThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateThemeAlias' => [ 'name' => 'CreateThemeAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'CreateThemeAliasRequest', ], 'output' => [ 'shape' => 'CreateThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTopic' => [ 'name' => 'CreateTopic', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics', ], 'input' => [ 'shape' => 'CreateTopicRequest', ], 'output' => [ 'shape' => 'CreateTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTopicRefreshSchedule' => [ 'name' => 'CreateTopicRefreshSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules', ], 'input' => [ 'shape' => 'CreateTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'CreateTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateVPCConnection' => [ 'name' => 'CreateVPCConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections', ], 'input' => [ 'shape' => 'CreateVPCConnectionRequest', ], 'output' => [ 'shape' => 'CreateVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteAccountCustomization' => [ 'name' => 'DeleteAccountCustomization', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'DeleteAccountCustomizationRequest', ], 'output' => [ 'shape' => 'DeleteAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteAccountSubscription' => [ 'name' => 'DeleteAccountSubscription', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'DeleteAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'DeleteAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteAnalysis' => [ 'name' => 'DeleteAnalysis', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'DeleteAnalysisRequest', ], 'output' => [ 'shape' => 'DeleteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDashboard' => [ 'name' => 'DeleteDashboard', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'DeleteDashboardRequest', ], 'output' => [ 'shape' => 'DeleteDashboardResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSet' => [ 'name' => 'DeleteDataSet', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'DeleteDataSetRequest', ], 'output' => [ 'shape' => 'DeleteDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSetRefreshProperties' => [ 'name' => 'DeleteDataSetRefreshProperties', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'DeleteDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'DeleteDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteFolder' => [ 'name' => 'DeleteFolder', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'DeleteFolderRequest', ], 'output' => [ 'shape' => 'DeleteFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteFolderMembership' => [ 'name' => 'DeleteFolderMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}', ], 'input' => [ 'shape' => 'DeleteFolderMembershipRequest', ], 'output' => [ 'shape' => 'DeleteFolderMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteGroupMembership' => [ 'name' => 'DeleteGroupMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'DeleteGroupMembershipRequest', ], 'output' => [ 'shape' => 'DeleteGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteIAMPolicyAssignment' => [ 'name' => 'DeleteIAMPolicyAssignment', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'DeleteIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'DeleteIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteIdentityPropagationConfig' => [ 'name' => 'DeleteIdentityPropagationConfig', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config/{Service}', ], 'input' => [ 'shape' => 'DeleteIdentityPropagationConfigRequest', ], 'output' => [ 'shape' => 'DeleteIdentityPropagationConfigResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteNamespace' => [ 'name' => 'DeleteNamespace', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}', ], 'input' => [ 'shape' => 'DeleteNamespaceRequest', ], 'output' => [ 'shape' => 'DeleteNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteRefreshSchedule' => [ 'name' => 'DeleteRefreshSchedule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}', ], 'input' => [ 'shape' => 'DeleteRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DeleteRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteRoleCustomPermission' => [ 'name' => 'DeleteRoleCustomPermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'DeleteRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'DeleteRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteRoleMembership' => [ 'name' => 'DeleteRoleMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}', ], 'input' => [ 'shape' => 'DeleteRoleMembershipRequest', ], 'output' => [ 'shape' => 'DeleteRoleMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteTemplate' => [ 'name' => 'DeleteTemplate', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'DeleteTemplateRequest', ], 'output' => [ 'shape' => 'DeleteTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTemplateAlias' => [ 'name' => 'DeleteTemplateAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DeleteTemplateAliasRequest', ], 'output' => [ 'shape' => 'DeleteTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTheme' => [ 'name' => 'DeleteTheme', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'DeleteThemeRequest', ], 'output' => [ 'shape' => 'DeleteThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteThemeAlias' => [ 'name' => 'DeleteThemeAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DeleteThemeAliasRequest', ], 'output' => [ 'shape' => 'DeleteThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTopic' => [ 'name' => 'DeleteTopic', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'DeleteTopicRequest', ], 'output' => [ 'shape' => 'DeleteTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTopicRefreshSchedule' => [ 'name' => 'DeleteTopicRefreshSchedule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'DeleteTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DeleteTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteUserByPrincipalId' => [ 'name' => 'DeleteUserByPrincipalId', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}', ], 'input' => [ 'shape' => 'DeleteUserByPrincipalIdRequest', ], 'output' => [ 'shape' => 'DeleteUserByPrincipalIdResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteVPCConnection' => [ 'name' => 'DeleteVPCConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'DeleteVPCConnectionRequest', ], 'output' => [ 'shape' => 'DeleteVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAccountCustomization' => [ 'name' => 'DescribeAccountCustomization', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'DescribeAccountCustomizationRequest', ], 'output' => [ 'shape' => 'DescribeAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAccountSettings' => [ 'name' => 'DescribeAccountSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/settings', ], 'input' => [ 'shape' => 'DescribeAccountSettingsRequest', ], 'output' => [ 'shape' => 'DescribeAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAccountSubscription' => [ 'name' => 'DescribeAccountSubscription', 'http' => [ 'method' => 'GET', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'DescribeAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'DescribeAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAnalysis' => [ 'name' => 'DescribeAnalysis', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'DescribeAnalysisRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAnalysisDefinition' => [ 'name' => 'DescribeAnalysisDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition', ], 'input' => [ 'shape' => 'DescribeAnalysisDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAnalysisPermissions' => [ 'name' => 'DescribeAnalysisPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions', ], 'input' => [ 'shape' => 'DescribeAnalysisPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAssetBundleExportJob' => [ 'name' => 'DescribeAssetBundleExportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}', ], 'input' => [ 'shape' => 'DescribeAssetBundleExportJobRequest', ], 'output' => [ 'shape' => 'DescribeAssetBundleExportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeAssetBundleImportJob' => [ 'name' => 'DescribeAssetBundleImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}', ], 'input' => [ 'shape' => 'DescribeAssetBundleImportJobRequest', ], 'output' => [ 'shape' => 'DescribeAssetBundleImportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeDashboard' => [ 'name' => 'DescribeDashboard', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'DescribeDashboardRequest', ], 'output' => [ 'shape' => 'DescribeDashboardResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardDefinition' => [ 'name' => 'DescribeDashboardDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition', ], 'input' => [ 'shape' => 'DescribeDashboardDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDashboardDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardPermissions' => [ 'name' => 'DescribeDashboardPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions', ], 'input' => [ 'shape' => 'DescribeDashboardPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDashboardPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardSnapshotJob' => [ 'name' => 'DescribeDashboardSnapshotJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}', ], 'input' => [ 'shape' => 'DescribeDashboardSnapshotJobRequest', ], 'output' => [ 'shape' => 'DescribeDashboardSnapshotJobResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardSnapshotJobResult' => [ 'name' => 'DescribeDashboardSnapshotJobResult', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result', ], 'input' => [ 'shape' => 'DescribeDashboardSnapshotJobResultRequest', ], 'output' => [ 'shape' => 'DescribeDashboardSnapshotJobResultResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSet' => [ 'name' => 'DescribeDataSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'DescribeDataSetRequest', ], 'output' => [ 'shape' => 'DescribeDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSetPermissions' => [ 'name' => 'DescribeDataSetPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions', ], 'input' => [ 'shape' => 'DescribeDataSetPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDataSetPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSetRefreshProperties' => [ 'name' => 'DescribeDataSetRefreshProperties', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'DescribeDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'DescribeDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSource' => [ 'name' => 'DescribeDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'DescribeDataSourceRequest', ], 'output' => [ 'shape' => 'DescribeDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSourcePermissions' => [ 'name' => 'DescribeDataSourcePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions', ], 'input' => [ 'shape' => 'DescribeDataSourcePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDataSourcePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolder' => [ 'name' => 'DescribeFolder', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'DescribeFolderRequest', ], 'output' => [ 'shape' => 'DescribeFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolderPermissions' => [ 'name' => 'DescribeFolderPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/permissions', ], 'input' => [ 'shape' => 'DescribeFolderPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeFolderPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolderResolvedPermissions' => [ 'name' => 'DescribeFolderResolvedPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions', ], 'input' => [ 'shape' => 'DescribeFolderResolvedPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeFolderResolvedPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeGroup' => [ 'name' => 'DescribeGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'DescribeGroupRequest', ], 'output' => [ 'shape' => 'DescribeGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeGroupMembership' => [ 'name' => 'DescribeGroupMembership', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'DescribeGroupMembershipRequest', ], 'output' => [ 'shape' => 'DescribeGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeIAMPolicyAssignment' => [ 'name' => 'DescribeIAMPolicyAssignment', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'DescribeIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'DescribeIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeIngestion' => [ 'name' => 'DescribeIngestion', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'DescribeIngestionRequest', ], 'output' => [ 'shape' => 'DescribeIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeIpRestriction' => [ 'name' => 'DescribeIpRestriction', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/ip-restriction', ], 'input' => [ 'shape' => 'DescribeIpRestrictionRequest', ], 'output' => [ 'shape' => 'DescribeIpRestrictionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeKeyRegistration' => [ 'name' => 'DescribeKeyRegistration', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/key-registration', ], 'input' => [ 'shape' => 'DescribeKeyRegistrationRequest', ], 'output' => [ 'shape' => 'DescribeKeyRegistrationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeNamespace' => [ 'name' => 'DescribeNamespace', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}', ], 'input' => [ 'shape' => 'DescribeNamespaceRequest', ], 'output' => [ 'shape' => 'DescribeNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeRefreshSchedule' => [ 'name' => 'DescribeRefreshSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}', ], 'input' => [ 'shape' => 'DescribeRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DescribeRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeRoleCustomPermission' => [ 'name' => 'DescribeRoleCustomPermission', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'DescribeRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'DescribeRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeTemplate' => [ 'name' => 'DescribeTemplate', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'DescribeTemplateRequest', ], 'output' => [ 'shape' => 'DescribeTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplateAlias' => [ 'name' => 'DescribeTemplateAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DescribeTemplateAliasRequest', ], 'output' => [ 'shape' => 'DescribeTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplateDefinition' => [ 'name' => 'DescribeTemplateDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/definition', ], 'input' => [ 'shape' => 'DescribeTemplateDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTemplateDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplatePermissions' => [ 'name' => 'DescribeTemplatePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/permissions', ], 'input' => [ 'shape' => 'DescribeTemplatePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeTemplatePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTheme' => [ 'name' => 'DescribeTheme', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'DescribeThemeRequest', ], 'output' => [ 'shape' => 'DescribeThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeThemeAlias' => [ 'name' => 'DescribeThemeAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DescribeThemeAliasRequest', ], 'output' => [ 'shape' => 'DescribeThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeThemePermissions' => [ 'name' => 'DescribeThemePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/permissions', ], 'input' => [ 'shape' => 'DescribeThemePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeThemePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopic' => [ 'name' => 'DescribeTopic', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'DescribeTopicRequest', ], 'output' => [ 'shape' => 'DescribeTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicPermissions' => [ 'name' => 'DescribeTopicPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/permissions', ], 'input' => [ 'shape' => 'DescribeTopicPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeTopicPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicRefresh' => [ 'name' => 'DescribeTopicRefresh', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}', ], 'input' => [ 'shape' => 'DescribeTopicRefreshRequest', ], 'output' => [ 'shape' => 'DescribeTopicRefreshResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicRefreshSchedule' => [ 'name' => 'DescribeTopicRefreshSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'DescribeTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DescribeTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeVPCConnection' => [ 'name' => 'DescribeVPCConnection', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'DescribeVPCConnectionRequest', ], 'output' => [ 'shape' => 'DescribeVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GenerateEmbedUrlForAnonymousUser' => [ 'name' => 'GenerateEmbedUrlForAnonymousUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/embed-url/anonymous-user', ], 'input' => [ 'shape' => 'GenerateEmbedUrlForAnonymousUserRequest', ], 'output' => [ 'shape' => 'GenerateEmbedUrlForAnonymousUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GenerateEmbedUrlForRegisteredUser' => [ 'name' => 'GenerateEmbedUrlForRegisteredUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/embed-url/registered-user', ], 'input' => [ 'shape' => 'GenerateEmbedUrlForRegisteredUserRequest', ], 'output' => [ 'shape' => 'GenerateEmbedUrlForRegisteredUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GetDashboardEmbedUrl' => [ 'name' => 'GetDashboardEmbedUrl', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url', ], 'input' => [ 'shape' => 'GetDashboardEmbedUrlRequest', ], 'output' => [ 'shape' => 'GetDashboardEmbedUrlResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'DomainNotWhitelistedException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'IdentityTypeNotSupportedException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GetSessionEmbedUrl' => [ 'name' => 'GetSessionEmbedUrl', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/session-embed-url', ], 'input' => [ 'shape' => 'GetSessionEmbedUrlRequest', ], 'output' => [ 'shape' => 'GetSessionEmbedUrlResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListAnalyses' => [ 'name' => 'ListAnalyses', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses', ], 'input' => [ 'shape' => 'ListAnalysesRequest', ], 'output' => [ 'shape' => 'ListAnalysesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListAssetBundleExportJobs' => [ 'name' => 'ListAssetBundleExportJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs', ], 'input' => [ 'shape' => 'ListAssetBundleExportJobsRequest', ], 'output' => [ 'shape' => 'ListAssetBundleExportJobsResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAssetBundleImportJobs' => [ 'name' => 'ListAssetBundleImportJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs', ], 'input' => [ 'shape' => 'ListAssetBundleImportJobsRequest', ], 'output' => [ 'shape' => 'ListAssetBundleImportJobsResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDashboardVersions' => [ 'name' => 'ListDashboardVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions', ], 'input' => [ 'shape' => 'ListDashboardVersionsRequest', ], 'output' => [ 'shape' => 'ListDashboardVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDashboards' => [ 'name' => 'ListDashboards', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards', ], 'input' => [ 'shape' => 'ListDashboardsRequest', ], 'output' => [ 'shape' => 'ListDashboardsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDataSets' => [ 'name' => 'ListDataSets', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets', ], 'input' => [ 'shape' => 'ListDataSetsRequest', ], 'output' => [ 'shape' => 'ListDataSetsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListFolderMembers' => [ 'name' => 'ListFolderMembers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members', ], 'input' => [ 'shape' => 'ListFolderMembersRequest', ], 'output' => [ 'shape' => 'ListFolderMembersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListFolders' => [ 'name' => 'ListFolders', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders', ], 'input' => [ 'shape' => 'ListFoldersRequest', ], 'output' => [ 'shape' => 'ListFoldersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListGroupMemberships' => [ 'name' => 'ListGroupMemberships', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members', ], 'input' => [ 'shape' => 'ListGroupMembershipsRequest', ], 'output' => [ 'shape' => 'ListGroupMembershipsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListIAMPolicyAssignments' => [ 'name' => 'ListIAMPolicyAssignments', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments', ], 'input' => [ 'shape' => 'ListIAMPolicyAssignmentsRequest', ], 'output' => [ 'shape' => 'ListIAMPolicyAssignmentsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIAMPolicyAssignmentsForUser' => [ 'name' => 'ListIAMPolicyAssignmentsForUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments', ], 'input' => [ 'shape' => 'ListIAMPolicyAssignmentsForUserRequest', ], 'output' => [ 'shape' => 'ListIAMPolicyAssignmentsForUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIdentityPropagationConfigs' => [ 'name' => 'ListIdentityPropagationConfigs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config', ], 'input' => [ 'shape' => 'ListIdentityPropagationConfigsRequest', ], 'output' => [ 'shape' => 'ListIdentityPropagationConfigsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIngestions' => [ 'name' => 'ListIngestions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions', ], 'input' => [ 'shape' => 'ListIngestionsRequest', ], 'output' => [ 'shape' => 'ListIngestionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListNamespaces' => [ 'name' => 'ListNamespaces', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces', ], 'input' => [ 'shape' => 'ListNamespacesRequest', ], 'output' => [ 'shape' => 'ListNamespacesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListRefreshSchedules' => [ 'name' => 'ListRefreshSchedules', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'ListRefreshSchedulesRequest', ], 'output' => [ 'shape' => 'ListRefreshSchedulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListRoleMemberships' => [ 'name' => 'ListRoleMemberships', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members', ], 'input' => [ 'shape' => 'ListRoleMembershipsRequest', ], 'output' => [ 'shape' => 'ListRoleMembershipsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplateAliases' => [ 'name' => 'ListTemplateAliases', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases', ], 'input' => [ 'shape' => 'ListTemplateAliasesRequest', ], 'output' => [ 'shape' => 'ListTemplateAliasesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplateVersions' => [ 'name' => 'ListTemplateVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/versions', ], 'input' => [ 'shape' => 'ListTemplateVersionsRequest', ], 'output' => [ 'shape' => 'ListTemplateVersionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplates' => [ 'name' => 'ListTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates', ], 'input' => [ 'shape' => 'ListTemplatesRequest', ], 'output' => [ 'shape' => 'ListTemplatesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemeAliases' => [ 'name' => 'ListThemeAliases', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases', ], 'input' => [ 'shape' => 'ListThemeAliasesRequest', ], 'output' => [ 'shape' => 'ListThemeAliasesResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemeVersions' => [ 'name' => 'ListThemeVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/versions', ], 'input' => [ 'shape' => 'ListThemeVersionsRequest', ], 'output' => [ 'shape' => 'ListThemeVersionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemes' => [ 'name' => 'ListThemes', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes', ], 'input' => [ 'shape' => 'ListThemesRequest', ], 'output' => [ 'shape' => 'ListThemesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopicRefreshSchedules' => [ 'name' => 'ListTopicRefreshSchedules', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules', ], 'input' => [ 'shape' => 'ListTopicRefreshSchedulesRequest', ], 'output' => [ 'shape' => 'ListTopicRefreshSchedulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopicReviewedAnswers' => [ 'name' => 'ListTopicReviewedAnswers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers', ], 'input' => [ 'shape' => 'ListTopicReviewedAnswersRequest', ], 'output' => [ 'shape' => 'ListTopicReviewedAnswersResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopics' => [ 'name' => 'ListTopics', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics', ], 'input' => [ 'shape' => 'ListTopicsRequest', ], 'output' => [ 'shape' => 'ListTopicsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListUserGroups' => [ 'name' => 'ListUserGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups', ], 'input' => [ 'shape' => 'ListUserGroupsRequest', ], 'output' => [ 'shape' => 'ListUserGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListVPCConnections' => [ 'name' => 'ListVPCConnections', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections', ], 'input' => [ 'shape' => 'ListVPCConnectionsRequest', ], 'output' => [ 'shape' => 'ListVPCConnectionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'PutDataSetRefreshProperties' => [ 'name' => 'PutDataSetRefreshProperties', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'PutDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'PutDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'RegisterUser' => [ 'name' => 'RegisterUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users', ], 'input' => [ 'shape' => 'RegisterUserRequest', ], 'output' => [ 'shape' => 'RegisterUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'RestoreAnalysis' => [ 'name' => 'RestoreAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'RestoreAnalysisRequest', ], 'output' => [ 'shape' => 'RestoreAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchAnalyses' => [ 'name' => 'SearchAnalyses', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/analyses', ], 'input' => [ 'shape' => 'SearchAnalysesRequest', ], 'output' => [ 'shape' => 'SearchAnalysesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDashboards' => [ 'name' => 'SearchDashboards', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/dashboards', ], 'input' => [ 'shape' => 'SearchDashboardsRequest', ], 'output' => [ 'shape' => 'SearchDashboardsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDataSets' => [ 'name' => 'SearchDataSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/data-sets', ], 'input' => [ 'shape' => 'SearchDataSetsRequest', ], 'output' => [ 'shape' => 'SearchDataSetsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDataSources' => [ 'name' => 'SearchDataSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/data-sources', ], 'input' => [ 'shape' => 'SearchDataSourcesRequest', ], 'output' => [ 'shape' => 'SearchDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchFolders' => [ 'name' => 'SearchFolders', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/folders', ], 'input' => [ 'shape' => 'SearchFoldersRequest', ], 'output' => [ 'shape' => 'SearchFoldersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchGroups' => [ 'name' => 'SearchGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search', ], 'input' => [ 'shape' => 'SearchGroupsRequest', ], 'output' => [ 'shape' => 'SearchGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'StartAssetBundleExportJob' => [ 'name' => 'StartAssetBundleExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs/export', ], 'input' => [ 'shape' => 'StartAssetBundleExportJobRequest', ], 'output' => [ 'shape' => 'StartAssetBundleExportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StartAssetBundleImportJob' => [ 'name' => 'StartAssetBundleImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs/import', ], 'input' => [ 'shape' => 'StartAssetBundleImportJobRequest', ], 'output' => [ 'shape' => 'StartAssetBundleImportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StartDashboardSnapshotJob' => [ 'name' => 'StartDashboardSnapshotJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs', ], 'input' => [ 'shape' => 'StartDashboardSnapshotJobRequest', ], 'output' => [ 'shape' => 'StartDashboardSnapshotJobResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateAccountCustomization' => [ 'name' => 'UpdateAccountCustomization', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'UpdateAccountCustomizationRequest', ], 'output' => [ 'shape' => 'UpdateAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateAccountSettings' => [ 'name' => 'UpdateAccountSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/settings', ], 'input' => [ 'shape' => 'UpdateAccountSettingsRequest', ], 'output' => [ 'shape' => 'UpdateAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateAnalysis' => [ 'name' => 'UpdateAnalysis', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'UpdateAnalysisRequest', ], 'output' => [ 'shape' => 'UpdateAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateAnalysisPermissions' => [ 'name' => 'UpdateAnalysisPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions', ], 'input' => [ 'shape' => 'UpdateAnalysisPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateAnalysisPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboard' => [ 'name' => 'UpdateDashboard', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'UpdateDashboardRequest', ], 'output' => [ 'shape' => 'UpdateDashboardResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardLinks' => [ 'name' => 'UpdateDashboardLinks', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities', ], 'input' => [ 'shape' => 'UpdateDashboardLinksRequest', ], 'output' => [ 'shape' => 'UpdateDashboardLinksResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardPermissions' => [ 'name' => 'UpdateDashboardPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions', ], 'input' => [ 'shape' => 'UpdateDashboardPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDashboardPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardPublishedVersion' => [ 'name' => 'UpdateDashboardPublishedVersion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}', ], 'input' => [ 'shape' => 'UpdateDashboardPublishedVersionRequest', ], 'output' => [ 'shape' => 'UpdateDashboardPublishedVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSet' => [ 'name' => 'UpdateDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'UpdateDataSetRequest', ], 'output' => [ 'shape' => 'UpdateDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSetPermissions' => [ 'name' => 'UpdateDataSetPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions', ], 'input' => [ 'shape' => 'UpdateDataSetPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDataSetPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'CustomerManagedKeyUnavailableException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSourcePermissions' => [ 'name' => 'UpdateDataSourcePermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions', ], 'input' => [ 'shape' => 'UpdateDataSourcePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDataSourcePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateFolder' => [ 'name' => 'UpdateFolder', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'UpdateFolderRequest', ], 'output' => [ 'shape' => 'UpdateFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateFolderPermissions' => [ 'name' => 'UpdateFolderPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/permissions', ], 'input' => [ 'shape' => 'UpdateFolderPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateFolderPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateIAMPolicyAssignment' => [ 'name' => 'UpdateIAMPolicyAssignment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'UpdateIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'UpdateIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateIdentityPropagationConfig' => [ 'name' => 'UpdateIdentityPropagationConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config/{Service}', ], 'input' => [ 'shape' => 'UpdateIdentityPropagationConfigRequest', ], 'output' => [ 'shape' => 'UpdateIdentityPropagationConfigResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateIpRestriction' => [ 'name' => 'UpdateIpRestriction', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/ip-restriction', ], 'input' => [ 'shape' => 'UpdateIpRestrictionRequest', ], 'output' => [ 'shape' => 'UpdateIpRestrictionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateKeyRegistration' => [ 'name' => 'UpdateKeyRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/key-registration', ], 'input' => [ 'shape' => 'UpdateKeyRegistrationRequest', ], 'output' => [ 'shape' => 'UpdateKeyRegistrationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdatePublicSharingSettings' => [ 'name' => 'UpdatePublicSharingSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/public-sharing-settings', ], 'input' => [ 'shape' => 'UpdatePublicSharingSettingsRequest', ], 'output' => [ 'shape' => 'UpdatePublicSharingSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateRefreshSchedule' => [ 'name' => 'UpdateRefreshSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'UpdateRefreshScheduleRequest', ], 'output' => [ 'shape' => 'UpdateRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateRoleCustomPermission' => [ 'name' => 'UpdateRoleCustomPermission', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'UpdateRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'UpdateRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateSPICECapacityConfiguration' => [ 'name' => 'UpdateSPICECapacityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/spice-capacity-configuration', ], 'input' => [ 'shape' => 'UpdateSPICECapacityConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateSPICECapacityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplate' => [ 'name' => 'UpdateTemplate', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'UpdateTemplateRequest', ], 'output' => [ 'shape' => 'UpdateTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplateAlias' => [ 'name' => 'UpdateTemplateAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'UpdateTemplateAliasRequest', ], 'output' => [ 'shape' => 'UpdateTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplatePermissions' => [ 'name' => 'UpdateTemplatePermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/permissions', ], 'input' => [ 'shape' => 'UpdateTemplatePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateTemplatePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTheme' => [ 'name' => 'UpdateTheme', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'UpdateThemeRequest', ], 'output' => [ 'shape' => 'UpdateThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateThemeAlias' => [ 'name' => 'UpdateThemeAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'UpdateThemeAliasRequest', ], 'output' => [ 'shape' => 'UpdateThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateThemePermissions' => [ 'name' => 'UpdateThemePermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/permissions', ], 'input' => [ 'shape' => 'UpdateThemePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateThemePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopic' => [ 'name' => 'UpdateTopic', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'UpdateTopicRequest', ], 'output' => [ 'shape' => 'UpdateTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopicPermissions' => [ 'name' => 'UpdateTopicPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/permissions', ], 'input' => [ 'shape' => 'UpdateTopicPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateTopicPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopicRefreshSchedule' => [ 'name' => 'UpdateTopicRefreshSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'UpdateTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'UpdateTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateUser' => [ 'name' => 'UpdateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'UpdateUserRequest', ], 'output' => [ 'shape' => 'UpdateUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateVPCConnection' => [ 'name' => 'UpdateVPCConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'UpdateVPCConnectionRequest', ], 'output' => [ 'shape' => 'UpdateVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'AccountCustomization' => [ 'type' => 'structure', 'members' => [ 'DefaultTheme' => [ 'shape' => 'Arn', ], 'DefaultEmailCustomizationTemplate' => [ 'shape' => 'Arn', ], ], ], 'AccountInfo' => [ 'type' => 'structure', 'members' => [ 'AccountName' => [ 'shape' => 'String', ], 'Edition' => [ 'shape' => 'Edition', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'AuthenticationType' => [ 'shape' => 'String', ], 'AccountSubscriptionStatus' => [ 'shape' => 'String', ], 'IAMIdentityCenterInstanceArn' => [ 'shape' => 'String', ], ], ], 'AccountName' => [ 'type' => 'string', 'max' => 62, 'min' => 1, 'pattern' => '^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*', ], 'AccountSettings' => [ 'type' => 'structure', 'members' => [ 'AccountName' => [ 'shape' => 'String', ], 'Edition' => [ 'shape' => 'Edition', ], 'DefaultNamespace' => [ 'shape' => 'Namespace', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'PublicSharingEnabled' => [ 'shape' => 'Boolean', ], 'TerminationProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, 'min' => 1, ], 'ActiveIAMPolicyAssignment' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'PolicyArn' => [ 'shape' => 'Arn', ], ], ], 'ActiveIAMPolicyAssignmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActiveIAMPolicyAssignment', ], ], 'AdHocFilteringOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'AdditionalDashboardIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 20, 'min' => 1, ], 'AggFunction' => [ 'type' => 'structure', 'members' => [ 'Aggregation' => [ 'shape' => 'AggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggFunctionParamMap', ], 'Period' => [ 'shape' => 'TopicTimeGranularity', ], 'PeriodField' => [ 'shape' => 'LimitedString', ], ], ], 'AggFunctionParamKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AggFunctionParamMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'AggFunctionParamKey', ], 'value' => [ 'shape' => 'AggFunctionParamValue', ], ], 'AggFunctionParamValue' => [ 'type' => 'string', 'max' => 1024, ], 'AggType' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MIN', 'MAX', 'COUNT', 'AVERAGE', 'DISTINCT_COUNT', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', 'MEDIAN', 'PTD_SUM', 'PTD_MIN', 'PTD_MAX', 'PTD_COUNT', 'PTD_DISTINCT_COUNT', 'PTD_AVERAGE', 'COLUMN', 'CUSTOM', ], ], 'AggregationFunction' => [ 'type' => 'structure', 'members' => [ 'NumericalAggregationFunction' => [ 'shape' => 'NumericalAggregationFunction', ], 'CategoricalAggregationFunction' => [ 'shape' => 'CategoricalAggregationFunction', ], 'DateAggregationFunction' => [ 'shape' => 'DateAggregationFunction', ], 'AttributeAggregationFunction' => [ 'shape' => 'AttributeAggregationFunction', ], ], ], 'AggregationFunctionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'LimitedString', ], 'value' => [ 'shape' => 'LimitedString', ], ], 'AggregationPartitionBy' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'AggregationPartitionByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationPartitionBy', ], 'max' => 50, ], 'AggregationSortConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', 'SortDirection', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'SortDirection' => [ 'shape' => 'SortDirection', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], ], ], 'AggregationSortConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationSortConfiguration', ], 'max' => 100, ], 'AliasName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)', ], 'AllSheetsFilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [], ], 'AmazonElasticsearchParameters' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'Domain', ], ], ], 'AmazonOpenSearchParameters' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'Domain', ], ], ], 'Analysis' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Errors' => [ 'shape' => 'AnalysisErrorList', ], 'DataSetArns' => [ 'shape' => 'DataSetArnsList', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'AnalysisDefaults' => [ 'type' => 'structure', 'required' => [ 'DefaultNewSheetConfiguration', ], 'members' => [ 'DefaultNewSheetConfiguration' => [ 'shape' => 'DefaultNewSheetConfiguration', ], ], ], 'AnalysisDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifierDeclarations', ], 'members' => [ 'DataSetIdentifierDeclarations' => [ 'shape' => 'DataSetIdentifierDeclarationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], 'QueryExecutionOptions' => [ 'shape' => 'QueryExecutionOptions', ], ], ], 'AnalysisError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'AnalysisErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'AnalysisErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisError', ], 'min' => 1, ], 'AnalysisErrorType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'PARAMETER_VALUE_INCOMPATIBLE', 'PARAMETER_TYPE_INVALID', 'PARAMETER_NOT_FOUND', 'COLUMN_TYPE_MISMATCH', 'COLUMN_GEOGRAPHIC_ROLE_MISMATCH', 'COLUMN_REPLACEMENT_MISSING', ], ], 'AnalysisFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_USER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'ANALYSIS_NAME', ], ], 'AnalysisName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'AnalysisSearchFilter' => [ 'type' => 'structure', 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'AnalysisFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'AnalysisSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisSearchFilter', ], 'max' => 1, 'min' => 1, ], 'AnalysisSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceTemplate' => [ 'shape' => 'AnalysisSourceTemplate', ], ], ], 'AnalysisSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'DataSetReferences', 'Arn', ], 'members' => [ 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'AnalysisSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AnalysisSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisSummary', ], 'max' => 100, ], 'Anchor' => [ 'type' => 'structure', 'members' => [ 'AnchorType' => [ 'shape' => 'AnchorType', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'Offset' => [ 'shape' => 'Integer', ], ], ], 'AnchorDateConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnchorOption' => [ 'shape' => 'AnchorOption', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'AnchorOption' => [ 'type' => 'string', 'enum' => [ 'NOW', ], ], 'AnchorType' => [ 'type' => 'string', 'enum' => [ 'TODAY', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'EnabledFeatures' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures', ], 'DisabledFeatures' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures', ], 'FeatureConfigurations' => [ 'shape' => 'AnonymousUserDashboardFeatureConfigurations', ], ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature' => [ 'type' => 'string', 'enum' => [ 'SHARED_VIEW', ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature' => [ 'type' => 'string', 'enum' => [ 'SHARED_VIEW', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature', ], ], 'AnonymousUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], ], ], 'AnonymousUserDashboardVisualEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardVisualId', ], 'members' => [ 'InitialDashboardVisualId' => [ 'shape' => 'DashboardVisualId', ], ], ], 'AnonymousUserEmbeddingExperienceConfiguration' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfiguration', ], 'DashboardVisual' => [ 'shape' => 'AnonymousUserDashboardVisualEmbeddingConfiguration', ], 'QSearchBar' => [ 'shape' => 'AnonymousUserQSearchBarEmbeddingConfiguration', ], 'GenerativeQnA' => [ 'shape' => 'AnonymousUserGenerativeQnAEmbeddingConfiguration', ], ], ], 'AnonymousUserGenerativeQnAEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialTopicId', ], 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'AnonymousUserQSearchBarEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialTopicId', ], 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'AnonymousUserSnapshotJobResult' => [ 'type' => 'structure', 'members' => [ 'FileGroups' => [ 'shape' => 'SnapshotJobResultFileGroupList', ], ], ], 'AnonymousUserSnapshotJobResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserSnapshotJobResult', ], ], 'AnswerId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[A-Za-z0-9-_.\\\\+]*$', ], 'AnswerIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnswerId', ], ], 'ArcAxisConfiguration' => [ 'type' => 'structure', 'members' => [ 'Range' => [ 'shape' => 'ArcAxisDisplayRange', ], 'ReserveRange' => [ 'shape' => 'Integer', ], ], ], 'ArcAxisDisplayRange' => [ 'type' => 'structure', 'members' => [ 'Min' => [ 'shape' => 'Double', 'box' => true, ], 'Max' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'ArcConfiguration' => [ 'type' => 'structure', 'members' => [ 'ArcAngle' => [ 'shape' => 'Double', 'box' => true, ], 'ArcThickness' => [ 'shape' => 'ArcThicknessOptions', ], ], ], 'ArcOptions' => [ 'type' => 'structure', 'members' => [ 'ArcThickness' => [ 'shape' => 'ArcThickness', ], ], ], 'ArcThickness' => [ 'type' => 'string', 'enum' => [ 'SMALL', 'MEDIUM', 'LARGE', 'WHOLE', ], ], 'ArcThicknessOptions' => [ 'type' => 'string', 'enum' => [ 'SMALL', 'MEDIUM', 'LARGE', ], ], 'Arn' => [ 'type' => 'string', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], ], 'AssetBundleCloudFormationOverridePropertyConfiguration' => [ 'type' => 'structure', 'members' => [ 'ResourceIdOverrideConfiguration' => [ 'shape' => 'AssetBundleExportJobResourceIdOverrideConfiguration', ], 'VPCConnections' => [ 'shape' => 'AssetBundleExportJobVPCConnectionOverridePropertiesList', ], 'RefreshSchedules' => [ 'shape' => 'AssetBundleExportJobRefreshScheduleOverridePropertiesList', ], 'DataSources' => [ 'shape' => 'AssetBundleExportJobDataSourceOverridePropertiesList', ], 'DataSets' => [ 'shape' => 'AssetBundleExportJobDataSetOverridePropertiesList', ], 'Themes' => [ 'shape' => 'AssetBundleExportJobThemeOverridePropertiesList', ], 'Analyses' => [ 'shape' => 'AssetBundleExportJobAnalysisOverridePropertiesList', ], 'Dashboards' => [ 'shape' => 'AssetBundleExportJobDashboardOverridePropertiesList', ], ], ], 'AssetBundleExportFormat' => [ 'type' => 'string', 'enum' => [ 'CLOUDFORMATION_JSON', 'QUICKSIGHT_JSON', ], ], 'AssetBundleExportJobAnalysisOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobAnalysisPropertyToOverrideList', ], ], ], 'AssetBundleExportJobAnalysisOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobAnalysisOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobAnalysisPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobAnalysisPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobAnalysisPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDashboardOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDashboardPropertyToOverrideList', ], ], ], 'AssetBundleExportJobDashboardOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDashboardOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDashboardPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobDashboardPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDashboardPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDataSetOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDataSetPropertyToOverrideList', ], ], ], 'AssetBundleExportJobDataSetOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSetOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDataSetPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobDataSetPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSetPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDataSourceOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDataSourcePropertyToOverrideList', ], ], ], 'AssetBundleExportJobDataSourceOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSourceOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDataSourcePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', 'DisableSsl', 'SecretArn', 'Username', 'Password', 'Domain', 'WorkGroup', 'Host', 'Port', 'Database', 'DataSetName', 'Catalog', 'InstanceId', 'ClusterId', 'ManifestFileLocation', 'Warehouse', 'RoleArn', 'ProductType', ], ], 'AssetBundleExportJobDataSourcePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSourcePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobError' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Type' => [ 'shape' => 'NonEmptyString', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleExportJobErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobError', ], ], 'AssetBundleExportJobRefreshScheduleOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList', ], ], ], 'AssetBundleExportJobRefreshScheduleOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobRefreshScheduleOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobRefreshSchedulePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'StartAfterDateTime', ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobRefreshSchedulePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobResourceIdOverrideConfiguration' => [ 'type' => 'structure', 'members' => [ 'PrefixForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED_FOR_IMMEDIATE_EXECUTION', 'IN_PROGRESS', 'SUCCESSFUL', 'FAILED', ], ], 'AssetBundleExportJobSummary' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleExportJobStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobSummary', ], ], 'AssetBundleExportJobThemeOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobThemePropertyToOverrideList', ], ], ], 'AssetBundleExportJobThemeOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobThemeOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobThemePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobThemePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobThemePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobVPCConnectionOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobVPCConnectionPropertyToOverrideList', ], ], ], 'AssetBundleExportJobVPCConnectionOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobVPCConnectionOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobVPCConnectionPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', 'DnsResolvers', 'RoleArn', ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobVPCConnectionPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobValidationStrategy' => [ 'type' => 'structure', 'members' => [ 'StrictModeForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobWarning' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleExportJobWarningList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobWarning', ], ], 'AssetBundleImportBodyBlob' => [ 'type' => 'blob', 'max' => 20971520, 'min' => 0, 'sensitive' => true, ], 'AssetBundleImportFailureAction' => [ 'type' => 'string', 'enum' => [ 'DO_NOTHING', 'ROLLBACK', ], ], 'AssetBundleImportJobAnalysisOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'AnalysisId', ], 'members' => [ 'AnalysisId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobAnalysisOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobAnalysisOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'AnalysisIds', 'Permissions', ], 'members' => [ 'AnalysisIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobAnalysisOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverridePermissions', ], 'max' => 1, 'min' => 1, ], 'AssetBundleImportJobAnalysisOverrideTags' => [ 'type' => 'structure', 'required' => [ 'AnalysisIds', 'Tags', ], 'members' => [ 'AnalysisIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobAnalysisOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDashboardOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DashboardId', ], 'members' => [ 'DashboardId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobDashboardOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDashboardOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DashboardIds', ], 'members' => [ 'DashboardIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], 'LinkSharingConfiguration' => [ 'shape' => 'AssetBundleResourceLinkSharingConfiguration', ], ], ], 'AssetBundleImportJobDashboardOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDashboardOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DashboardIds', 'Tags', ], 'members' => [ 'DashboardIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDashboardOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDataSetOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobDataSetOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDataSetOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DataSetIds', 'Permissions', ], 'members' => [ 'DataSetIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobDataSetOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDataSetOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DataSetIds', 'Tags', ], 'members' => [ 'DataSetIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDataSetOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDataSourceCredentialPair' => [ 'type' => 'structure', 'required' => [ 'Username', 'Password', ], 'members' => [ 'Username' => [ 'shape' => 'DbUsername', ], 'Password' => [ 'shape' => 'Password', ], ], 'sensitive' => true, ], 'AssetBundleImportJobDataSourceCredentials' => [ 'type' => 'structure', 'members' => [ 'CredentialPair' => [ 'shape' => 'AssetBundleImportJobDataSourceCredentialPair', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'AssetBundleImportJobDataSourceOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSourceId', ], 'members' => [ 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'Credentials' => [ 'shape' => 'AssetBundleImportJobDataSourceCredentials', ], ], ], 'AssetBundleImportJobDataSourceOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDataSourceOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DataSourceIds', 'Permissions', ], 'members' => [ 'DataSourceIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobDataSourceOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDataSourceOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DataSourceIds', 'Tags', ], 'members' => [ 'DataSourceIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDataSourceOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobError' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Type' => [ 'shape' => 'NonEmptyString', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleImportJobErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobError', ], ], 'AssetBundleImportJobOverrideParameters' => [ 'type' => 'structure', 'members' => [ 'ResourceIdOverrideConfiguration' => [ 'shape' => 'AssetBundleImportJobResourceIdOverrideConfiguration', ], 'VPCConnections' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideParametersList', ], 'RefreshSchedules' => [ 'shape' => 'AssetBundleImportJobRefreshScheduleOverrideParametersList', ], 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideParametersList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideParametersList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverrideParametersList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideParametersList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideParametersList', ], ], ], 'AssetBundleImportJobOverridePermissions' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverridePermissionsList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverridePermissionsList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverridePermissionsList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverridePermissionsList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverridePermissionsList', ], ], ], 'AssetBundleImportJobOverrideTags' => [ 'type' => 'structure', 'members' => [ 'VPCConnections' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideTagsList', ], 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideTagsList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideTagsList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverrideTagsList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideTagsList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideTagsList', ], ], ], 'AssetBundleImportJobOverrideValidationStrategy' => [ 'type' => 'structure', 'members' => [ 'StrictModeForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleImportJobRefreshScheduleOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'ScheduleId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', ], 'ScheduleId' => [ 'shape' => 'String', ], 'StartAfterDateTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssetBundleImportJobRefreshScheduleOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobRefreshScheduleOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobResourceIdOverrideConfiguration' => [ 'type' => 'structure', 'members' => [ 'PrefixForAllResources' => [ 'shape' => 'String', ], ], ], 'AssetBundleImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED_FOR_IMMEDIATE_EXECUTION', 'IN_PROGRESS', 'SUCCESSFUL', 'FAILED', 'FAILED_ROLLBACK_IN_PROGRESS', 'FAILED_ROLLBACK_COMPLETED', 'FAILED_ROLLBACK_ERROR', ], ], 'AssetBundleImportJobSummary' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleImportJobStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], ], ], 'AssetBundleImportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobSummary', ], ], 'AssetBundleImportJobThemeOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'ThemeId', ], 'members' => [ 'ThemeId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobThemeOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobThemeOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'ThemeIds', 'Permissions', ], 'members' => [ 'ThemeIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobThemeOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobThemeOverrideTags' => [ 'type' => 'structure', 'required' => [ 'ThemeIds', 'Tags', ], 'members' => [ 'ThemeIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobThemeOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobVPCConnectionOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'VPCConnectionId', ], 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'AssetBundleImportJobVPCConnectionOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobVPCConnectionOverrideTags' => [ 'type' => 'structure', 'required' => [ 'VPCConnectionIds', 'Tags', ], 'members' => [ 'VPCConnectionIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobVPCConnectionOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobWarning' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleImportJobWarningList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobWarning', ], ], 'AssetBundleImportSource' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'AssetBundleImportBodyBlob', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AssetBundleImportSourceDescription' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'SensitiveS3Uri', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AssetBundlePrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], 'max' => 64, 'min' => 1, ], 'AssetBundleResourceArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, 'min' => 1, ], 'AssetBundleResourceLinkSharingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleResourcePermissions' => [ 'type' => 'structure', 'required' => [ 'Principals', 'Actions', ], 'members' => [ 'Principals' => [ 'shape' => 'AssetBundlePrincipalList', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'AssetBundleRestrictiveResourceId' => [ 'type' => 'string', 'pattern' => '\\*|[\\w\\-]{1,2048}', ], 'AssetBundleRestrictiveResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleRestrictiveResourceId', ], 'max' => 50, 'min' => 1, ], 'AssetOptions' => [ 'type' => 'structure', 'members' => [ 'Timezone' => [ 'shape' => 'String', ], 'WeekStart' => [ 'shape' => 'DayOfTheWeek', ], ], ], 'AssignmentStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DRAFT', 'DISABLED', ], ], 'AthenaParameters' => [ 'type' => 'structure', 'members' => [ 'WorkGroup' => [ 'shape' => 'WorkGroup', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'AttributeAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleAttributeAggregation' => [ 'shape' => 'SimpleAttributeAggregationFunction', ], 'ValueForMultipleValues' => [ 'shape' => 'String', ], ], ], 'AuroraParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'AuroraPostgreSqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'AuthenticationMethodOption' => [ 'type' => 'string', 'enum' => [ 'IAM_AND_QUICKSIGHT', 'IAM_ONLY', 'ACTIVE_DIRECTORY', 'IAM_IDENTITY_CENTER', ], ], 'AuthorSpecifiedAggregation' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', 'MIN', 'MAX', 'MEDIAN', 'SUM', 'AVERAGE', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', ], ], 'AuthorSpecifiedAggregations' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorSpecifiedAggregation', ], ], 'AuthorizedTargetsByService' => [ 'type' => 'structure', 'members' => [ 'Service' => [ 'shape' => 'ServiceType', ], 'AuthorizedTargets' => [ 'shape' => 'AuthorizedTargetsList', ], ], ], 'AuthorizedTargetsByServices' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedTargetsByService', ], ], 'AuthorizedTargetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'AwsAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'AwsAndAccountId' => [ 'type' => 'string', 'pattern' => '^(aws|[0-9]{12})$', ], 'AwsIotAnalyticsParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetName', ], 'members' => [ 'DataSetName' => [ 'shape' => 'DataSetName', ], ], ], 'AxisBinding' => [ 'type' => 'string', 'enum' => [ 'PRIMARY_YAXIS', 'SECONDARY_YAXIS', ], ], 'AxisDataOptions' => [ 'type' => 'structure', 'members' => [ 'NumericAxisOptions' => [ 'shape' => 'NumericAxisOptions', ], 'DateAxisOptions' => [ 'shape' => 'DateAxisOptions', ], ], ], 'AxisDisplayDataDrivenRange' => [ 'type' => 'structure', 'members' => [], ], 'AxisDisplayMinMaxRange' => [ 'type' => 'structure', 'members' => [ 'Minimum' => [ 'shape' => 'Double', 'box' => true, ], 'Maximum' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TickLabelOptions' => [ 'shape' => 'AxisTickLabelOptions', ], 'AxisLineVisibility' => [ 'shape' => 'Visibility', ], 'GridLineVisibility' => [ 'shape' => 'Visibility', ], 'DataOptions' => [ 'shape' => 'AxisDataOptions', ], 'ScrollbarOptions' => [ 'shape' => 'ScrollBarOptions', ], 'AxisOffset' => [ 'shape' => 'PixelLength', ], ], ], 'AxisDisplayRange' => [ 'type' => 'structure', 'members' => [ 'MinMax' => [ 'shape' => 'AxisDisplayMinMaxRange', ], 'DataDriven' => [ 'shape' => 'AxisDisplayDataDrivenRange', ], ], ], 'AxisLabelOptions' => [ 'type' => 'structure', 'members' => [ 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'CustomLabel' => [ 'shape' => 'String', ], 'ApplyTo' => [ 'shape' => 'AxisLabelReferenceOptions', ], ], ], 'AxisLabelOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AxisLabelOptions', ], 'max' => 100, ], 'AxisLabelReferenceOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'AxisLinearScale' => [ 'type' => 'structure', 'members' => [ 'StepCount' => [ 'shape' => 'Integer', 'box' => true, ], 'StepSize' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisLogarithmicScale' => [ 'type' => 'structure', 'members' => [ 'Base' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisScale' => [ 'type' => 'structure', 'members' => [ 'Linear' => [ 'shape' => 'AxisLinearScale', ], 'Logarithmic' => [ 'shape' => 'AxisLogarithmicScale', ], ], ], 'AxisTickLabelOptions' => [ 'type' => 'structure', 'members' => [ 'LabelOptions' => [ 'shape' => 'LabelOptions', ], 'RotationAngle' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'BarChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'BarChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'BarChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'BarChartSortConfiguration', ], 'Orientation' => [ 'shape' => 'BarChartOrientation', ], 'BarsArrangement' => [ 'shape' => 'BarsArrangement', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'BarChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'BarChartAggregatedFieldWells' => [ 'shape' => 'BarChartAggregatedFieldWells', ], ], ], 'BarChartOrientation' => [ 'type' => 'string', 'enum' => [ 'HORIZONTAL', 'VERTICAL', ], ], 'BarChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'BarChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'BarChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'BarsArrangement' => [ 'type' => 'string', 'enum' => [ 'CLUSTERED', 'STACKED', 'STACKED_PERCENT', ], ], 'BaseMapStyleType' => [ 'type' => 'string', 'enum' => [ 'LIGHT_GRAY', 'DARK_GRAY', 'STREET', 'IMAGERY', ], ], 'BatchCreateTopicReviewedAnswerRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Answers', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'Answers' => [ 'shape' => 'CreateTopicReviewedAnswers', ], ], ], 'BatchCreateTopicReviewedAnswerResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'SucceededAnswers' => [ 'shape' => 'SucceededTopicReviewedAnswers', ], 'InvalidAnswers' => [ 'shape' => 'InvalidTopicReviewedAnswers', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'BatchDeleteTopicReviewedAnswerRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'AnswerIds' => [ 'shape' => 'AnswerIds', ], ], ], 'BatchDeleteTopicReviewedAnswerResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'SucceededAnswers' => [ 'shape' => 'SucceededTopicReviewedAnswers', ], 'InvalidAnswers' => [ 'shape' => 'InvalidTopicReviewedAnswers', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'BigQueryParameters' => [ 'type' => 'structure', 'required' => [ 'ProjectId', ], 'members' => [ 'ProjectId' => [ 'shape' => 'ProjectId', ], 'DataSetRegion' => [ 'shape' => 'DataSetRegion', ], ], ], 'BinCountLimit' => [ 'type' => 'long', 'max' => 1000, 'min' => 0, ], 'BinCountOptions' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'BinCountValue', ], ], ], 'BinCountValue' => [ 'type' => 'integer', 'min' => 0, ], 'BinWidthOptions' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'BinWidthValue', ], 'BinCountLimit' => [ 'shape' => 'BinCountLimit', ], ], ], 'BinWidthValue' => [ 'type' => 'double', 'min' => 0, ], 'BodySectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'SectionId', 'Content', ], 'members' => [ 'SectionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Content' => [ 'shape' => 'BodySectionContent', ], 'Style' => [ 'shape' => 'SectionStyle', ], 'PageBreakConfiguration' => [ 'shape' => 'SectionPageBreakConfiguration', ], 'RepeatConfiguration' => [ 'shape' => 'BodySectionRepeatConfiguration', ], ], ], 'BodySectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionConfiguration', ], 'max' => 28, ], 'BodySectionContent' => [ 'type' => 'structure', 'members' => [ 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], ], ], 'BodySectionDynamicCategoryDimensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'BodySectionDynamicDimensionLimit', 'box' => true, ], 'SortByMetrics' => [ 'shape' => 'BodySectionDynamicDimensionSortConfigurationList', ], ], ], 'BodySectionDynamicDimensionLimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'BodySectionDynamicDimensionSortConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnSort', ], 'max' => 100, ], 'BodySectionDynamicNumericDimensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'BodySectionDynamicDimensionLimit', 'box' => true, ], 'SortByMetrics' => [ 'shape' => 'BodySectionDynamicDimensionSortConfigurationList', ], ], ], 'BodySectionRepeatConfiguration' => [ 'type' => 'structure', 'members' => [ 'DimensionConfigurations' => [ 'shape' => 'BodySectionRepeatDimensionConfigurationList', ], 'PageBreakConfiguration' => [ 'shape' => 'BodySectionRepeatPageBreakConfiguration', ], 'NonRepeatingVisuals' => [ 'shape' => 'NonRepeatingVisualsList', ], ], ], 'BodySectionRepeatDimensionConfiguration' => [ 'type' => 'structure', 'members' => [ 'DynamicCategoryDimensionConfiguration' => [ 'shape' => 'BodySectionDynamicCategoryDimensionConfiguration', ], 'DynamicNumericDimensionConfiguration' => [ 'shape' => 'BodySectionDynamicNumericDimensionConfiguration', ], ], ], 'BodySectionRepeatDimensionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionRepeatDimensionConfiguration', ], 'max' => 3, ], 'BodySectionRepeatPageBreakConfiguration' => [ 'type' => 'structure', 'members' => [ 'After' => [ 'shape' => 'SectionAfterPageBreak', ], ], ], 'BookmarksConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BorderStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'BoxPlotAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'BoxPlotDimensionFieldList', ], 'Values' => [ 'shape' => 'BoxPlotMeasureFieldList', ], ], ], 'BoxPlotChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'BoxPlotFieldWells', ], 'SortConfiguration' => [ 'shape' => 'BoxPlotSortConfiguration', ], 'BoxPlotOptions' => [ 'shape' => 'BoxPlotOptions', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'BoxPlotDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'BoxPlotFieldWells' => [ 'type' => 'structure', 'members' => [ 'BoxPlotAggregatedFieldWells' => [ 'shape' => 'BoxPlotAggregatedFieldWells', ], ], ], 'BoxPlotFillStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'TRANSPARENT', ], ], 'BoxPlotMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 5, ], 'BoxPlotOptions' => [ 'type' => 'structure', 'members' => [ 'StyleOptions' => [ 'shape' => 'BoxPlotStyleOptions', ], 'OutlierVisibility' => [ 'shape' => 'Visibility', ], 'AllDataPointsVisibility' => [ 'shape' => 'Visibility', ], ], ], 'BoxPlotSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'PaginationConfiguration' => [ 'shape' => 'PaginationConfiguration', ], ], ], 'BoxPlotStyleOptions' => [ 'type' => 'structure', 'members' => [ 'FillStyle' => [ 'shape' => 'BoxPlotFillStyle', ], ], ], 'BoxPlotVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'BoxPlotChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'CIDR' => [ 'type' => 'string', 'pattern' => '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$', ], 'CalculatedColumn' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'ColumnId', 'Expression', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'ColumnId' => [ 'shape' => 'ColumnId', ], 'Expression' => [ 'shape' => 'Expression', ], ], ], 'CalculatedColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CalculatedColumn', ], 'max' => 128, 'min' => 1, ], 'CalculatedField' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'Name', 'Expression', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Name' => [ 'shape' => 'ColumnName', ], 'Expression' => [ 'shape' => 'CalculatedFieldExpression', ], ], ], 'CalculatedFieldExpression' => [ 'type' => 'string', 'max' => 32000, 'min' => 1, 'sensitive' => true, ], 'CalculatedFieldReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], 'max' => 250, ], 'CalculatedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'CalculatedField', ], 'max' => 500, ], 'CalculatedMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Expression', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Expression' => [ 'shape' => 'Expression', ], ], ], 'CancelIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'IngestionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], ], ], 'CancelIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CascadingControlConfiguration' => [ 'type' => 'structure', 'members' => [ 'SourceControls' => [ 'shape' => 'CascadingControlSourceList', ], ], ], 'CascadingControlSource' => [ 'type' => 'structure', 'members' => [ 'SourceSheetControlId' => [ 'shape' => 'String', ], 'ColumnToMatch' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'CascadingControlSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CascadingControlSource', ], 'max' => 200, ], 'CastColumnTypeOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'NewColumnType', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'NewColumnType' => [ 'shape' => 'ColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], 'Format' => [ 'shape' => 'TypeCastFormat', ], ], ], 'Catalog' => [ 'type' => 'string', 'max' => 128, ], 'CategoricalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', ], ], 'CategoricalDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], ], ], 'CategoricalMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'CategoricalAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], ], ], 'CategoryDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'CategoryValues', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], ], ], 'CategoryFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'Configuration', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Configuration' => [ 'shape' => 'CategoryFilterConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'CategoryFilterConfiguration' => [ 'type' => 'structure', 'members' => [ 'FilterListConfiguration' => [ 'shape' => 'FilterListConfiguration', ], 'CustomFilterListConfiguration' => [ 'shape' => 'CustomFilterListConfiguration', ], 'CustomFilterConfiguration' => [ 'shape' => 'CustomFilterConfiguration', ], ], ], 'CategoryFilterFunction' => [ 'type' => 'string', 'enum' => [ 'EXACT', 'CONTAINS', ], ], 'CategoryFilterMatchOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'DOES_NOT_EQUAL', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', 'ENDS_WITH', ], ], 'CategoryFilterSelectAllOptions' => [ 'type' => 'string', 'enum' => [ 'FILTER_ALL_VALUES', ], ], 'CategoryFilterType' => [ 'type' => 'string', 'enum' => [ 'CUSTOM_FILTER', 'CUSTOM_FILTER_LIST', 'FILTER_LIST', ], ], 'CategoryInnerFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'Configuration', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Configuration' => [ 'shape' => 'CategoryFilterConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'CategoryValue' => [ 'type' => 'string', 'max' => 512, ], 'CategoryValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoryValue', ], 'max' => 100000, ], 'CellValueSynonym' => [ 'type' => 'structure', 'members' => [ 'CellValue' => [ 'shape' => 'LimitedString', ], 'Synonyms' => [ 'shape' => 'StringList', ], ], ], 'CellValueSynonyms' => [ 'type' => 'list', 'member' => [ 'shape' => 'CellValueSynonym', ], ], 'ChartAxisLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'SortIconVisibility' => [ 'shape' => 'Visibility', ], 'AxisLabelOptions' => [ 'shape' => 'AxisLabelOptionsList', ], ], ], 'ClusterId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ClusterMarker' => [ 'type' => 'structure', 'members' => [ 'SimpleClusterMarker' => [ 'shape' => 'SimpleClusterMarker', ], ], ], 'ClusterMarkerConfiguration' => [ 'type' => 'structure', 'members' => [ 'ClusterMarker' => [ 'shape' => 'ClusterMarker', ], ], ], 'CollectiveConstant' => [ 'type' => 'structure', 'members' => [ 'ValueList' => [ 'shape' => 'StringList', ], ], ], 'CollectiveConstantEntry' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'Value' => [ 'shape' => 'ConstantValueString', ], ], ], 'CollectiveConstantEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectiveConstantEntry', ], 'max' => 2000, ], 'ColorFillType' => [ 'type' => 'string', 'enum' => [ 'DISCRETE', 'GRADIENT', ], ], 'ColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HexColor', ], 'max' => 100, ], 'ColorScale' => [ 'type' => 'structure', 'required' => [ 'Colors', 'ColorFillType', ], 'members' => [ 'Colors' => [ 'shape' => 'ColorScaleColorList', ], 'ColorFillType' => [ 'shape' => 'ColorFillType', ], 'NullValueColor' => [ 'shape' => 'DataColor', ], ], ], 'ColorScaleColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataColor', ], 'max' => 3, 'min' => 2, ], 'ColorsConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomColors' => [ 'shape' => 'CustomColorsList', ], ], ], 'ColumnConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'FormatConfiguration' => [ 'shape' => 'FormatConfiguration', ], 'Role' => [ 'shape' => 'ColumnRole', ], 'ColorsConfiguration' => [ 'shape' => 'ColorsConfiguration', ], ], ], 'ColumnConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnConfiguration', ], 'max' => 2000, ], 'ColumnDataRole' => [ 'type' => 'string', 'enum' => [ 'DIMENSION', 'MEASURE', ], ], 'ColumnDataSubType' => [ 'type' => 'string', 'enum' => [ 'FLOAT', 'FIXED', ], ], 'ColumnDataType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'INTEGER', 'DECIMAL', 'DATETIME', ], ], 'ColumnDescription' => [ 'type' => 'structure', 'members' => [ 'Text' => [ 'shape' => 'ColumnDescriptiveText', ], ], ], 'ColumnDescriptiveText' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'ColumnGroup' => [ 'type' => 'structure', 'members' => [ 'GeoSpatialColumnGroup' => [ 'shape' => 'GeoSpatialColumnGroup', ], ], ], 'ColumnGroupColumnSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], ], 'ColumnGroupColumnSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroupColumnSchema', ], 'max' => 500, ], 'ColumnGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroup', ], 'max' => 8, 'min' => 1, ], 'ColumnGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ColumnGroupSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ColumnGroupColumnSchemaList' => [ 'shape' => 'ColumnGroupColumnSchemaList', ], ], ], 'ColumnGroupSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroupSchema', ], 'max' => 500, ], 'ColumnHierarchy' => [ 'type' => 'structure', 'members' => [ 'ExplicitHierarchy' => [ 'shape' => 'ExplicitHierarchy', ], 'DateTimeHierarchy' => [ 'shape' => 'DateTimeHierarchy', ], 'PredefinedHierarchy' => [ 'shape' => 'PredefinedHierarchy', ], ], ], 'ColumnHierarchyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnHierarchy', ], 'max' => 2, ], 'ColumnId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ColumnIdentifier' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'ColumnName', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'ColumnName' => [ 'shape' => 'ColumnName', ], ], ], 'ColumnLevelPermissionRule' => [ 'type' => 'structure', 'members' => [ 'Principals' => [ 'shape' => 'PrincipalList', ], 'ColumnNames' => [ 'shape' => 'ColumnNameList', ], ], ], 'ColumnLevelPermissionRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnLevelPermissionRule', ], 'min' => 1, ], 'ColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnName', ], 'max' => 16, 'min' => 1, ], 'ColumnName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ColumnNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'ColumnOrderingType' => [ 'type' => 'string', 'enum' => [ 'GREATER_IS_BETTER', 'LESSER_IS_BETTER', 'SPECIFIED', ], ], 'ColumnRole' => [ 'type' => 'string', 'enum' => [ 'DIMENSION', 'MEASURE', ], ], 'ColumnSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'GeographicRole' => [ 'shape' => 'String', ], ], ], 'ColumnSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnSchema', ], 'max' => 500, ], 'ColumnSort' => [ 'type' => 'structure', 'required' => [ 'SortBy', 'Direction', ], 'members' => [ 'SortBy' => [ 'shape' => 'ColumnIdentifier', ], 'Direction' => [ 'shape' => 'SortDirection', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], ], ], 'ColumnTag' => [ 'type' => 'structure', 'members' => [ 'ColumnGeographicRole' => [ 'shape' => 'GeoSpatialDataRole', ], 'ColumnDescription' => [ 'shape' => 'ColumnDescription', ], ], ], 'ColumnTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnTag', ], 'max' => 16, 'min' => 1, ], 'ColumnTagName' => [ 'type' => 'string', 'enum' => [ 'COLUMN_GEOGRAPHIC_ROLE', 'COLUMN_DESCRIPTION', ], ], 'ColumnTagNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnTagName', ], ], 'ColumnTooltipItem' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Label' => [ 'shape' => 'String', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'Aggregation' => [ 'shape' => 'AggregationFunction', ], 'TooltipTarget' => [ 'shape' => 'TooltipTarget', ], ], ], 'ComboChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'BarValues' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'LineValues' => [ 'shape' => 'MeasureFieldList', ], ], ], 'ComboChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'ComboChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'ComboChartSortConfiguration', ], 'BarsArrangement' => [ 'shape' => 'BarsArrangement', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SecondaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'SecondaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SingleAxisOptions' => [ 'shape' => 'SingleAxisOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'BarDataLabels' => [ 'shape' => 'DataLabelOptions', ], 'LineDataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'ComboChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'ComboChartAggregatedFieldWells' => [ 'shape' => 'ComboChartAggregatedFieldWells', ], ], ], 'ComboChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'ComboChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'ComboChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'ComparativeOrder' => [ 'type' => 'structure', 'members' => [ 'UseOrdering' => [ 'shape' => 'ColumnOrderingType', ], 'SpecifedOrder' => [ 'shape' => 'StringList', ], 'TreatUndefinedSpecifiedValues' => [ 'shape' => 'UndefinedSpecifiedValueType', ], ], ], 'ComparisonConfiguration' => [ 'type' => 'structure', 'members' => [ 'ComparisonMethod' => [ 'shape' => 'ComparisonMethod', ], 'ComparisonFormat' => [ 'shape' => 'ComparisonFormatConfiguration', ], ], ], 'ComparisonFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NumberDisplayFormatConfiguration' => [ 'shape' => 'NumberDisplayFormatConfiguration', ], 'PercentageDisplayFormatConfiguration' => [ 'shape' => 'PercentageDisplayFormatConfiguration', ], ], ], 'ComparisonMethod' => [ 'type' => 'string', 'enum' => [ 'DIFFERENCE', 'PERCENT_DIFFERENCE', 'PERCENT', ], ], 'ComparisonMethodType' => [ 'type' => 'string', 'enum' => [ 'DIFF', 'PERC_DIFF', 'DIFF_AS_PERC', 'POP_CURRENT_DIFF_AS_PERC', 'POP_CURRENT_DIFF', 'POP_OVERTIME_DIFF_AS_PERC', 'POP_OVERTIME_DIFF', 'PERCENT_OF_TOTAL', 'RUNNING_SUM', 'MOVING_AVERAGE', ], ], 'Computation' => [ 'type' => 'structure', 'members' => [ 'TopBottomRanked' => [ 'shape' => 'TopBottomRankedComputation', ], 'TopBottomMovers' => [ 'shape' => 'TopBottomMoversComputation', ], 'TotalAggregation' => [ 'shape' => 'TotalAggregationComputation', ], 'MaximumMinimum' => [ 'shape' => 'MaximumMinimumComputation', ], 'MetricComparison' => [ 'shape' => 'MetricComparisonComputation', ], 'PeriodOverPeriod' => [ 'shape' => 'PeriodOverPeriodComputation', ], 'PeriodToDate' => [ 'shape' => 'PeriodToDateComputation', ], 'GrowthRate' => [ 'shape' => 'GrowthRateComputation', ], 'UniqueValues' => [ 'shape' => 'UniqueValuesComputation', ], 'Forecast' => [ 'shape' => 'ForecastComputation', ], ], ], 'ComputationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Computation', ], 'max' => 100, ], 'ConcurrentUpdatingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'ConditionalFormattingColor' => [ 'type' => 'structure', 'members' => [ 'Solid' => [ 'shape' => 'ConditionalFormattingSolidColor', ], 'Gradient' => [ 'shape' => 'ConditionalFormattingGradientColor', ], ], ], 'ConditionalFormattingCustomIconCondition' => [ 'type' => 'structure', 'required' => [ 'Expression', 'IconOptions', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'IconOptions' => [ 'shape' => 'ConditionalFormattingCustomIconOptions', ], 'Color' => [ 'shape' => 'HexColor', ], 'DisplayConfiguration' => [ 'shape' => 'ConditionalFormattingIconDisplayConfiguration', ], ], ], 'ConditionalFormattingCustomIconOptions' => [ 'type' => 'structure', 'members' => [ 'Icon' => [ 'shape' => 'Icon', ], 'UnicodeIcon' => [ 'shape' => 'UnicodeIcon', ], ], ], 'ConditionalFormattingGradientColor' => [ 'type' => 'structure', 'required' => [ 'Expression', 'Color', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Color' => [ 'shape' => 'GradientColor', ], ], ], 'ConditionalFormattingIcon' => [ 'type' => 'structure', 'members' => [ 'IconSet' => [ 'shape' => 'ConditionalFormattingIconSet', ], 'CustomCondition' => [ 'shape' => 'ConditionalFormattingCustomIconCondition', ], ], ], 'ConditionalFormattingIconDisplayConfiguration' => [ 'type' => 'structure', 'members' => [ 'IconDisplayOption' => [ 'shape' => 'ConditionalFormattingIconDisplayOption', ], ], ], 'ConditionalFormattingIconDisplayOption' => [ 'type' => 'string', 'enum' => [ 'ICON_ONLY', ], ], 'ConditionalFormattingIconSet' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'IconSetType' => [ 'shape' => 'ConditionalFormattingIconSetType', ], ], ], 'ConditionalFormattingIconSetType' => [ 'type' => 'string', 'enum' => [ 'PLUS_MINUS', 'CHECK_X', 'THREE_COLOR_ARROW', 'THREE_GRAY_ARROW', 'CARET_UP_MINUS_DOWN', 'THREE_SHAPE', 'THREE_CIRCLE', 'FLAGS', 'BARS', 'FOUR_COLOR_ARROW', 'FOUR_GRAY_ARROW', ], ], 'ConditionalFormattingSolidColor' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConstantType' => [ 'type' => 'string', 'enum' => [ 'SINGULAR', 'RANGE', 'COLLECTIVE', ], ], 'ConstantValueString' => [ 'type' => 'string', 'max' => 1024, ], 'ContextMenuOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ContributionAnalysisDefault' => [ 'type' => 'structure', 'required' => [ 'MeasureFieldId', 'ContributorDimensions', ], 'members' => [ 'MeasureFieldId' => [ 'shape' => 'FieldId', ], 'ContributorDimensions' => [ 'shape' => 'ContributorDimensionList', ], ], ], 'ContributionAnalysisDefaultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContributionAnalysisDefault', ], 'max' => 200, 'min' => 1, ], 'ContributionAnalysisDirection' => [ 'type' => 'string', 'enum' => [ 'INCREASE', 'DECREASE', 'NEUTRAL', ], ], 'ContributionAnalysisFactor' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], ], ], 'ContributionAnalysisFactorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContributionAnalysisFactor', ], 'max' => 50, ], 'ContributionAnalysisSortType' => [ 'type' => 'string', 'enum' => [ 'ABSOLUTE_DIFFERENCE', 'CONTRIBUTION_PERCENTAGE', 'DEVIATION_FROM_EXPECTED', 'PERCENTAGE_DIFFERENCE', ], ], 'ContributionAnalysisTimeRanges' => [ 'type' => 'structure', 'members' => [ 'StartRange' => [ 'shape' => 'TopicIRFilterOption', ], 'EndRange' => [ 'shape' => 'TopicIRFilterOption', ], ], ], 'ContributorDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 4, 'min' => 1, ], 'CopySourceArn' => [ 'type' => 'string', 'pattern' => '^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+', ], 'CreateAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AccountCustomization', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AuthenticationMethod', 'AwsAccountId', 'AccountName', 'NotificationEmail', ], 'members' => [ 'Edition' => [ 'shape' => 'Edition', ], 'AuthenticationMethod' => [ 'shape' => 'AuthenticationMethodOption', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AccountName' => [ 'shape' => 'AccountName', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'ActiveDirectoryName' => [ 'shape' => 'String', ], 'Realm' => [ 'shape' => 'String', ], 'DirectoryId' => [ 'shape' => 'String', ], 'AdminGroup' => [ 'shape' => 'GroupsList', ], 'AuthorGroup' => [ 'shape' => 'GroupsList', ], 'ReaderGroup' => [ 'shape' => 'GroupsList', ], 'AdminProGroup' => [ 'shape' => 'GroupsList', ], 'AuthorProGroup' => [ 'shape' => 'GroupsList', ], 'ReaderProGroup' => [ 'shape' => 'GroupsList', ], 'FirstName' => [ 'shape' => 'String', ], 'LastName' => [ 'shape' => 'String', ], 'EmailAddress' => [ 'shape' => 'String', ], 'ContactNumber' => [ 'shape' => 'String', ], 'IAMIdentityCenterInstanceArn' => [ 'shape' => 'String', ], ], ], 'CreateAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'SignupResponse' => [ 'shape' => 'SignupResponse', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'AnalysisSourceEntity', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateColumnsOperation' => [ 'type' => 'structure', 'required' => [ 'Columns', ], 'members' => [ 'Columns' => [ 'shape' => 'CalculatedColumnList', ], ], ], 'CreateDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'DashboardSourceEntity', ], 'Tags' => [ 'shape' => 'TagList', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'CreateDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'Name', 'PhysicalTableMap', 'ImportMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'IngestionArn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', 'Name', 'Type', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'Credentials' => [ 'shape' => 'DataSourceCredentials', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateFolderMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'MemberId', 'MemberType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'MemberId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'MemberId', ], 'MemberType' => [ 'shape' => 'MemberType', 'location' => 'uri', 'locationName' => 'MemberType', ], ], ], 'CreateFolderMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'FolderMember' => [ 'shape' => 'FolderMember', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'ParentFolderArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'CreateFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMember' => [ 'shape' => 'GroupMember', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'AssignmentStatus', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentId' => [ 'shape' => 'String', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'IngestionId', 'AwsAccountId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'IngestionType' => [ 'shape' => 'IngestionType', ], ], ], 'CreateIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'IngestionStatus' => [ 'shape' => 'IngestionStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'IdentityStore', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Namespace', ], 'CapacityRegion' => [ 'shape' => 'String', ], 'CreationStatus' => [ 'shape' => 'NamespaceStatus', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'Schedule', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Schedule' => [ 'shape' => 'RefreshSchedule', ], ], ], 'CreateRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'CreateRoleMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'AwsAccountId', 'Namespace', 'Role', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], ], ], 'CreateRoleMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', 'TemplateVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'CreateTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'TemplateSourceEntity', ], 'Tags' => [ 'shape' => 'TagList', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'CreateTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', 'ThemeVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'CreateThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'Name', 'BaseThemeId', 'Configuration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'Name' => [ 'shape' => 'ThemeName', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetArn', 'RefreshSchedule', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'String', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'CreateTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Topic', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'RefreshArn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateTopicReviewedAnswer' => [ 'type' => 'structure', 'required' => [ 'AnswerId', 'DatasetArn', 'Question', ], 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Question' => [ 'shape' => 'LimitedString', ], 'Mir' => [ 'shape' => 'TopicIR', ], 'PrimaryVisual' => [ 'shape' => 'TopicVisual', ], 'Template' => [ 'shape' => 'TopicTemplate', ], ], ], 'CreateTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'CreateTopicReviewedAnswer', ], 'max' => 100, 'min' => 0, ], 'CreateVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', 'Name', 'SubnetIds', 'SecurityGroupIds', 'RoleArn', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdRestricted', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdRestricted', ], 'CreationStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CredentialPair' => [ 'type' => 'structure', 'required' => [ 'Username', 'Password', ], 'members' => [ 'Username' => [ 'shape' => 'DbUsername', ], 'Password' => [ 'shape' => 'Password', ], 'AlternateDataSourceParameters' => [ 'shape' => 'DataSourceParametersList', ], ], ], 'CrossDatasetTypes' => [ 'type' => 'string', 'enum' => [ 'ALL_DATASETS', 'SINGLE_DATASET', ], ], 'CurrencyCode' => [ 'type' => 'string', 'pattern' => '[A-Z]{3}', ], 'CurrencyDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'Symbol' => [ 'shape' => 'CurrencyCode', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NumberScale' => [ 'shape' => 'NumberScale', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'CustomActionColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, ], 'CustomActionFilterOperation' => [ 'type' => 'structure', 'required' => [ 'SelectedFieldsConfiguration', 'TargetVisualsConfiguration', ], 'members' => [ 'SelectedFieldsConfiguration' => [ 'shape' => 'FilterOperationSelectedFieldsConfiguration', ], 'TargetVisualsConfiguration' => [ 'shape' => 'FilterOperationTargetVisualsConfiguration', ], ], ], 'CustomActionNavigationOperation' => [ 'type' => 'structure', 'members' => [ 'LocalNavigationConfiguration' => [ 'shape' => 'LocalNavigationConfiguration', ], ], ], 'CustomActionSetParametersOperation' => [ 'type' => 'structure', 'required' => [ 'ParameterValueConfigurations', ], 'members' => [ 'ParameterValueConfigurations' => [ 'shape' => 'SetParameterValueConfigurationList', ], ], ], 'CustomActionURLOperation' => [ 'type' => 'structure', 'required' => [ 'URLTemplate', 'URLTarget', ], 'members' => [ 'URLTemplate' => [ 'shape' => 'URLOperationTemplate', ], 'URLTarget' => [ 'shape' => 'URLTargetConfiguration', ], ], ], 'CustomColor' => [ 'type' => 'structure', 'required' => [ 'Color', ], 'members' => [ 'FieldValue' => [ 'shape' => 'FieldValue', ], 'Color' => [ 'shape' => 'HexColor', ], 'SpecialValue' => [ 'shape' => 'SpecialValue', ], ], ], 'CustomColorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomColor', ], 'max' => 50, ], 'CustomContentConfiguration' => [ 'type' => 'structure', 'members' => [ 'ContentUrl' => [ 'shape' => 'URLOperationTemplate', ], 'ContentType' => [ 'shape' => 'CustomContentType', ], 'ImageScaling' => [ 'shape' => 'CustomContentImageScalingConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'CustomContentImageScalingConfiguration' => [ 'type' => 'string', 'enum' => [ 'FIT_TO_HEIGHT', 'FIT_TO_WIDTH', 'DO_NOT_SCALE', 'SCALE_TO_VISUAL', ], ], 'CustomContentType' => [ 'type' => 'string', 'enum' => [ 'IMAGE', 'OTHER_EMBEDDED_CONTENT', ], ], 'CustomContentVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'CustomContentConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], ], ], 'CustomFilterConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', 'NullOption', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValue' => [ 'shape' => 'CategoryValue', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'CustomFilterListConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', 'NullOption', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'CustomLabel' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'CustomNarrativeOptions' => [ 'type' => 'structure', 'required' => [ 'Narrative', ], 'members' => [ 'Narrative' => [ 'shape' => 'NarrativeString', ], ], ], 'CustomParameterValues' => [ 'type' => 'structure', 'members' => [ 'StringValues' => [ 'shape' => 'StringDefaultValueList', ], 'IntegerValues' => [ 'shape' => 'IntegerDefaultValueList', ], 'DecimalValues' => [ 'shape' => 'DecimalDefaultValueList', ], 'DateTimeValues' => [ 'shape' => 'DateTimeDefaultValueList', ], ], ], 'CustomSql' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'Name', 'SqlQuery', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'CustomSqlName', ], 'SqlQuery' => [ 'shape' => 'SqlQuery', ], 'Columns' => [ 'shape' => 'InputColumnList', ], ], ], 'CustomSqlName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CustomValuesConfiguration' => [ 'type' => 'structure', 'required' => [ 'CustomValues', ], 'members' => [ 'IncludeNullValue' => [ 'shape' => 'BooleanObject', ], 'CustomValues' => [ 'shape' => 'CustomParameterValues', ], ], ], 'CustomerManagedKeyUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Dashboard' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'DashboardName', ], 'Version' => [ 'shape' => 'DashboardVersion', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastPublishedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'DashboardBehavior' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'DashboardError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'DashboardErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'DashboardErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardError', ], 'min' => 1, ], 'DashboardErrorType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'PARAMETER_VALUE_INCOMPATIBLE', 'PARAMETER_TYPE_INVALID', 'PARAMETER_NOT_FOUND', 'COLUMN_TYPE_MISMATCH', 'COLUMN_GEOGRAPHIC_ROLE_MISMATCH', 'COLUMN_REPLACEMENT_MISSING', ], ], 'DashboardFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_USER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DASHBOARD_NAME', ], ], 'DashboardName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'DashboardPublishOptions' => [ 'type' => 'structure', 'members' => [ 'AdHocFilteringOption' => [ 'shape' => 'AdHocFilteringOption', ], 'ExportToCSVOption' => [ 'shape' => 'ExportToCSVOption', ], 'SheetControlsOption' => [ 'shape' => 'SheetControlsOption', ], 'VisualPublishOptions' => [ 'shape' => 'DashboardVisualPublishOptions', 'deprecated' => true, 'deprecatedMessage' => 'VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields.', ], 'SheetLayoutElementMaximizationOption' => [ 'shape' => 'SheetLayoutElementMaximizationOption', ], 'VisualMenuOption' => [ 'shape' => 'VisualMenuOption', ], 'VisualAxisSortOption' => [ 'shape' => 'VisualAxisSortOption', ], 'ExportWithHiddenFieldsOption' => [ 'shape' => 'ExportWithHiddenFieldsOption', ], 'DataPointDrillUpDownOption' => [ 'shape' => 'DataPointDrillUpDownOption', ], 'DataPointMenuLabelOption' => [ 'shape' => 'DataPointMenuLabelOption', ], 'DataPointTooltipOption' => [ 'shape' => 'DataPointTooltipOption', ], ], ], 'DashboardSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DashboardFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DashboardSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DashboardSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceTemplate' => [ 'shape' => 'DashboardSourceTemplate', ], ], ], 'DashboardSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'DataSetReferences', 'Arn', ], 'members' => [ 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DashboardSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'PublishedVersionNumber' => [ 'shape' => 'VersionNumber', ], 'LastPublishedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DashboardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardSummary', ], 'max' => 100, ], 'DashboardUIState' => [ 'type' => 'string', 'enum' => [ 'EXPANDED', 'COLLAPSED', ], ], 'DashboardVersion' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Errors' => [ 'shape' => 'DashboardErrorList', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'DataSetArns' => [ 'shape' => 'DataSetArnsList', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'DashboardVersionDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifierDeclarations', ], 'members' => [ 'DataSetIdentifierDeclarations' => [ 'shape' => 'DataSetIdentifierDeclarationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], ], ], 'DashboardVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], ], ], 'DashboardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardVersionSummary', ], 'max' => 100, ], 'DashboardVisualId' => [ 'type' => 'structure', 'required' => [ 'DashboardId', 'SheetId', 'VisualId', ], 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DashboardVisualPublishOptions' => [ 'type' => 'structure', 'members' => [ 'ExportHiddenFieldsOption' => [ 'shape' => 'ExportHiddenFieldsOption', ], ], ], 'DataAggregation' => [ 'type' => 'structure', 'members' => [ 'DatasetRowDateGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'DefaultDateColumnName' => [ 'shape' => 'LimitedString', ], ], ], 'DataBarsOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'PositiveColor' => [ 'shape' => 'HexColor', ], 'NegativeColor' => [ 'shape' => 'HexColor', ], ], ], 'DataColor' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], 'DataValue' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'DataColorPalette' => [ 'type' => 'structure', 'members' => [ 'Colors' => [ 'shape' => 'ColorList', ], 'MinMaxGradient' => [ 'shape' => 'ColorList', ], 'EmptyFillColor' => [ 'shape' => 'HexColor', ], ], ], 'DataFieldSeriesItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'AxisBinding', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'SensitiveString', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'Settings' => [ 'shape' => 'LineChartSeriesSettings', ], ], ], 'DataLabelContent' => [ 'type' => 'string', 'enum' => [ 'VALUE', 'PERCENT', 'VALUE_AND_PERCENT', ], ], 'DataLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CategoryLabelVisibility' => [ 'shape' => 'Visibility', ], 'MeasureLabelVisibility' => [ 'shape' => 'Visibility', ], 'DataLabelTypes' => [ 'shape' => 'DataLabelTypes', ], 'Position' => [ 'shape' => 'DataLabelPosition', ], 'LabelContent' => [ 'shape' => 'DataLabelContent', ], 'LabelFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'LabelColor' => [ 'shape' => 'HexColor', ], 'Overlap' => [ 'shape' => 'DataLabelOverlap', ], 'TotalsVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DataLabelOverlap' => [ 'type' => 'string', 'enum' => [ 'DISABLE_OVERLAP', 'ENABLE_OVERLAP', ], ], 'DataLabelPosition' => [ 'type' => 'string', 'enum' => [ 'INSIDE', 'OUTSIDE', 'LEFT', 'TOP', 'BOTTOM', 'RIGHT', ], ], 'DataLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldLabelType' => [ 'shape' => 'FieldLabelType', ], 'DataPathLabelType' => [ 'shape' => 'DataPathLabelType', ], 'RangeEndsLabelType' => [ 'shape' => 'RangeEndsLabelType', ], 'MinimumLabelType' => [ 'shape' => 'MinimumLabelType', ], 'MaximumLabelType' => [ 'shape' => 'MaximumLabelType', ], ], ], 'DataLabelTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataLabelType', ], 'max' => 100, ], 'DataPathColor' => [ 'type' => 'structure', 'required' => [ 'Element', 'Color', ], 'members' => [ 'Element' => [ 'shape' => 'DataPathValue', ], 'Color' => [ 'shape' => 'HexColor', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'DataPathColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataPathColor', ], 'max' => 5000, ], 'DataPathLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'FieldValue', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'DataPathSort' => [ 'type' => 'structure', 'required' => [ 'Direction', 'SortPaths', ], 'members' => [ 'Direction' => [ 'shape' => 'SortDirection', ], 'SortPaths' => [ 'shape' => 'DataPathValueList', ], ], ], 'DataPathType' => [ 'type' => 'structure', 'members' => [ 'PivotTableDataPathType' => [ 'shape' => 'PivotTableDataPathType', ], ], ], 'DataPathValue' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'FieldValue', ], 'DataPathType' => [ 'shape' => 'DataPathType', ], ], ], 'DataPathValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataPathValue', ], 'max' => 20, ], 'DataPointDrillUpDownOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataPointMenuLabelOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataPointTooltipOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataSet' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'OutputColumns' => [ 'shape' => 'OutputColumnList', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ConsumedSpiceCapacityInBytes' => [ 'shape' => 'Long', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], ], ], 'DataSetArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, ], 'DataSetConfiguration' => [ 'type' => 'structure', 'members' => [ 'Placeholder' => [ 'shape' => 'String', ], 'DataSetSchema' => [ 'shape' => 'DataSetSchema', ], 'ColumnGroupSchemaList' => [ 'shape' => 'ColumnGroupSchemaList', ], ], ], 'DataSetConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetConfiguration', ], 'max' => 30, ], 'DataSetFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DATASET_NAME', ], ], 'DataSetIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'DataSetIdentifierDeclaration' => [ 'type' => 'structure', 'required' => [ 'Identifier', 'DataSetArn', ], 'members' => [ 'Identifier' => [ 'shape' => 'DataSetIdentifier', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'DataSetIdentifierDeclarationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetIdentifierDeclaration', ], 'max' => 50, 'min' => 1, ], 'DataSetImportMode' => [ 'type' => 'string', 'enum' => [ 'SPICE', 'DIRECT_QUERY', ], ], 'DataSetName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DataSetReference' => [ 'type' => 'structure', 'required' => [ 'DataSetPlaceholder', 'DataSetArn', ], 'members' => [ 'DataSetPlaceholder' => [ 'shape' => 'NonEmptyString', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'DataSetReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetReference', ], 'min' => 1, ], 'DataSetRefreshProperties' => [ 'type' => 'structure', 'required' => [ 'RefreshConfiguration', ], 'members' => [ 'RefreshConfiguration' => [ 'shape' => 'RefreshConfiguration', ], ], ], 'DataSetRegion' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'DataSetSchema' => [ 'type' => 'structure', 'members' => [ 'ColumnSchemaList' => [ 'shape' => 'ColumnSchemaList', ], ], ], 'DataSetSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DataSetFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DataSetSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DataSetSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfigurationApplied' => [ 'shape' => 'Boolean', ], 'ColumnLevelPermissionRulesApplied' => [ 'shape' => 'Boolean', ], ], ], 'DataSetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetSummary', ], ], 'DataSetUsageConfiguration' => [ 'type' => 'structure', 'members' => [ 'DisableUseAsDirectQuerySource' => [ 'shape' => 'Boolean', ], 'DisableUseAsImportedSource' => [ 'shape' => 'Boolean', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'AlternateDataSourceParameters' => [ 'shape' => 'DataSourceParametersList', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'ErrorInfo' => [ 'shape' => 'DataSourceErrorInfo', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'DataSourceCredentials' => [ 'type' => 'structure', 'members' => [ 'CredentialPair' => [ 'shape' => 'CredentialPair', ], 'CopySourceArn' => [ 'shape' => 'CopySourceArn', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], 'sensitive' => true, ], 'DataSourceErrorInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'DataSourceErrorInfoType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DataSourceErrorInfoType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'COPY_SOURCE_NOT_FOUND', 'TIMEOUT', 'ENGINE_VERSION_NOT_SUPPORTED', 'UNKNOWN_HOST', 'GENERIC_SQL_FAILURE', 'CONFLICT', 'UNKNOWN', ], ], 'DataSourceFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DATASOURCE_NAME', ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSource', ], ], 'DataSourceParameters' => [ 'type' => 'structure', 'members' => [ 'AmazonElasticsearchParameters' => [ 'shape' => 'AmazonElasticsearchParameters', ], 'AthenaParameters' => [ 'shape' => 'AthenaParameters', ], 'AuroraParameters' => [ 'shape' => 'AuroraParameters', ], 'AuroraPostgreSqlParameters' => [ 'shape' => 'AuroraPostgreSqlParameters', ], 'AwsIotAnalyticsParameters' => [ 'shape' => 'AwsIotAnalyticsParameters', ], 'JiraParameters' => [ 'shape' => 'JiraParameters', ], 'MariaDbParameters' => [ 'shape' => 'MariaDbParameters', ], 'MySqlParameters' => [ 'shape' => 'MySqlParameters', ], 'OracleParameters' => [ 'shape' => 'OracleParameters', ], 'PostgreSqlParameters' => [ 'shape' => 'PostgreSqlParameters', ], 'PrestoParameters' => [ 'shape' => 'PrestoParameters', ], 'RdsParameters' => [ 'shape' => 'RdsParameters', ], 'RedshiftParameters' => [ 'shape' => 'RedshiftParameters', ], 'S3Parameters' => [ 'shape' => 'S3Parameters', ], 'ServiceNowParameters' => [ 'shape' => 'ServiceNowParameters', ], 'SnowflakeParameters' => [ 'shape' => 'SnowflakeParameters', ], 'SparkParameters' => [ 'shape' => 'SparkParameters', ], 'SqlServerParameters' => [ 'shape' => 'SqlServerParameters', ], 'TeradataParameters' => [ 'shape' => 'TeradataParameters', ], 'TwitterParameters' => [ 'shape' => 'TwitterParameters', ], 'AmazonOpenSearchParameters' => [ 'shape' => 'AmazonOpenSearchParameters', ], 'ExasolParameters' => [ 'shape' => 'ExasolParameters', ], 'DatabricksParameters' => [ 'shape' => 'DatabricksParameters', ], 'StarburstParameters' => [ 'shape' => 'StarburstParameters', ], 'TrinoParameters' => [ 'shape' => 'TrinoParameters', ], 'BigQueryParameters' => [ 'shape' => 'BigQueryParameters', ], ], ], 'DataSourceParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceParameters', ], 'max' => 50, 'min' => 1, ], 'DataSourceSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DataSourceFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DataSourceSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DataSourceSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DataSourceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSummary', ], ], 'DataSourceType' => [ 'type' => 'string', 'enum' => [ 'ADOBE_ANALYTICS', 'AMAZON_ELASTICSEARCH', 'ATHENA', 'AURORA', 'AURORA_POSTGRESQL', 'AWS_IOT_ANALYTICS', 'GITHUB', 'JIRA', 'MARIADB', 'MYSQL', 'ORACLE', 'POSTGRESQL', 'PRESTO', 'REDSHIFT', 'S3', 'SALESFORCE', 'SERVICENOW', 'SNOWFLAKE', 'SPARK', 'SQLSERVER', 'TERADATA', 'TWITTER', 'TIMESTREAM', 'AMAZON_OPENSEARCH', 'EXASOL', 'DATABRICKS', 'STARBURST', 'TRINO', 'BIGQUERY', ], ], 'Database' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DatabaseGroup' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DatabaseGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatabaseGroup', ], 'max' => 50, 'min' => 1, ], 'DatabaseUser' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DatabricksParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'SqlEndpointPath', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'SqlEndpointPath' => [ 'shape' => 'SqlEndpointPath', ], ], ], 'DatasetMetadata' => [ 'type' => 'structure', 'required' => [ 'DatasetArn', ], 'members' => [ 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'LimitedString', ], 'DatasetDescription' => [ 'shape' => 'LimitedString', ], 'DataAggregation' => [ 'shape' => 'DataAggregation', ], 'Filters' => [ 'shape' => 'TopicFilters', ], 'Columns' => [ 'shape' => 'TopicColumns', ], 'CalculatedFields' => [ 'shape' => 'TopicCalculatedFields', ], 'NamedEntities' => [ 'shape' => 'TopicNamedEntities', ], ], ], 'DatasetParameter' => [ 'type' => 'structure', 'members' => [ 'StringDatasetParameter' => [ 'shape' => 'StringDatasetParameter', ], 'DecimalDatasetParameter' => [ 'shape' => 'DecimalDatasetParameter', ], 'IntegerDatasetParameter' => [ 'shape' => 'IntegerDatasetParameter', ], 'DateTimeDatasetParameter' => [ 'shape' => 'DateTimeDatasetParameter', ], ], ], 'DatasetParameterId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'DatasetParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetParameter', ], 'max' => 32, 'min' => 1, ], 'DatasetParameterName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'DatasetParameterValueType' => [ 'type' => 'string', 'enum' => [ 'MULTI_VALUED', 'SINGLE_VALUED', ], ], 'Datasets' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetMetadata', ], ], 'DateAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', 'MIN', 'MAX', ], ], 'DateAxisOptions' => [ 'type' => 'structure', 'members' => [ 'MissingDateVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DateDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'DateGranularity' => [ 'shape' => 'TimeGranularity', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'DateMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'DateAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'DateTimeDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'DefaultValues' => [ 'shape' => 'DateTimeDatasetParameterDefaultValues', ], ], ], 'DateTimeDatasetParameterDefaultValue' => [ 'type' => 'timestamp', ], 'DateTimeDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'DateTimeDatasetParameterValueList', ], ], ], 'DateTimeDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DateTimeDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'DateTimeDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveTimestamp', ], 'max' => 50000, ], 'DateTimeDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'DateTimeDefaultValueList', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], ], ], 'DateTimeFormat' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DateTimeFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], 'NumericFormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'DateTimeHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'DateTimeParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveTimestampList', ], ], ], 'DateTimeParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'DateTimeDefaultValues', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'ValueWhenUnset' => [ 'shape' => 'DateTimeValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'DateTimeParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DateTimeParameter', ], 'max' => 100, ], 'DateTimePickerControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], 'HelperTextVisibility' => [ 'shape' => 'Visibility', ], 'DateIconVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DateTimeValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveTimestamp', ], ], ], 'DayOfMonth' => [ 'type' => 'string', 'max' => 17, 'min' => 1, 'pattern' => '^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$', ], 'DayOfTheWeek' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'DayOfWeek' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'DbUsername' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DecimalDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'DecimalDatasetParameterDefaultValues', ], ], ], 'DecimalDatasetParameterDefaultValue' => [ 'type' => 'double', ], 'DecimalDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'DecimalDatasetParameterValueList', ], ], ], 'DecimalDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DecimalDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'DecimalDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveDoubleObject', ], 'max' => 50000, ], 'DecimalDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'DecimalDefaultValueList', ], ], ], 'DecimalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveDoubleList', ], ], ], 'DecimalParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'DecimalDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'DecimalValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'DecimalParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DecimalParameter', ], 'max' => 100, ], 'DecimalPlaces' => [ 'type' => 'long', 'max' => 20, 'min' => 0, ], 'DecimalPlacesConfiguration' => [ 'type' => 'structure', 'required' => [ 'DecimalPlaces', ], 'members' => [ 'DecimalPlaces' => [ 'shape' => 'DecimalPlaces', ], ], ], 'DecimalValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveDouble', 'box' => true, ], ], ], 'DefaultAggregation' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MAX', 'MIN', 'COUNT', 'DISTINCT_COUNT', 'AVERAGE', 'MEDIAN', 'STDEV', 'STDEVP', 'VAR', 'VARP', ], ], 'DefaultDateTimePickerControlOptions' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'SheetControlDateTimePickerType', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], ], ], 'DefaultFilterControlConfiguration' => [ 'type' => 'structure', 'required' => [ 'Title', 'ControlOptions', ], 'members' => [ 'Title' => [ 'shape' => 'SheetControlTitle', ], 'ControlOptions' => [ 'shape' => 'DefaultFilterControlOptions', ], ], ], 'DefaultFilterControlOptions' => [ 'type' => 'structure', 'members' => [ 'DefaultDateTimePickerOptions' => [ 'shape' => 'DefaultDateTimePickerControlOptions', ], 'DefaultListOptions' => [ 'shape' => 'DefaultFilterListControlOptions', ], 'DefaultDropdownOptions' => [ 'shape' => 'DefaultFilterDropDownControlOptions', ], 'DefaultTextFieldOptions' => [ 'shape' => 'DefaultTextFieldControlOptions', ], 'DefaultTextAreaOptions' => [ 'shape' => 'DefaultTextAreaControlOptions', ], 'DefaultSliderOptions' => [ 'shape' => 'DefaultSliderControlOptions', ], 'DefaultRelativeDateTimeOptions' => [ 'shape' => 'DefaultRelativeDateTimeControlOptions', ], ], ], 'DefaultFilterDropDownControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], ], ], 'DefaultFilterListControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], ], ], 'DefaultFormatting' => [ 'type' => 'structure', 'members' => [ 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], ], ], 'DefaultFreeFormLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutCanvasSizeOptions', ], ], ], 'DefaultGridLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'GridLayoutCanvasSizeOptions', ], ], ], 'DefaultInteractiveLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'Grid' => [ 'shape' => 'DefaultGridLayoutConfiguration', ], 'FreeForm' => [ 'shape' => 'DefaultFreeFormLayoutConfiguration', ], ], ], 'DefaultNewSheetConfiguration' => [ 'type' => 'structure', 'members' => [ 'InteractiveLayoutConfiguration' => [ 'shape' => 'DefaultInteractiveLayoutConfiguration', ], 'PaginatedLayoutConfiguration' => [ 'shape' => 'DefaultPaginatedLayoutConfiguration', ], 'SheetContentType' => [ 'shape' => 'SheetContentType', ], ], ], 'DefaultPaginatedLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'SectionBased' => [ 'shape' => 'DefaultSectionBasedLayoutConfiguration', ], ], ], 'DefaultRelativeDateTimeControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'RelativeDateTimeControlDisplayOptions', ], ], ], 'DefaultSectionBasedLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutCanvasSizeOptions', ], ], ], 'DefaultSliderControlOptions' => [ 'type' => 'structure', 'required' => [ 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlSliderType', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'DefaultTextAreaControlOptions' => [ 'type' => 'structure', 'members' => [ 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'DefaultTextFieldControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'DeleteAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], ], ], 'DeleteAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DeleteAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'RecoveryWindowInDays' => [ 'shape' => 'RecoveryWindowInDays', 'location' => 'querystring', 'locationName' => 'recovery-window-in-days', ], 'ForceDeleteWithoutRecovery' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'force-delete-without-recovery', ], ], ], 'DeleteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DeletionTime' => [ 'shape' => 'Timestamp', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DeleteDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DeleteDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteFolderMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'MemberId', 'MemberType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'MemberId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'MemberId', ], 'MemberType' => [ 'shape' => 'MemberType', 'location' => 'uri', 'locationName' => 'MemberType', ], ], ], 'DeleteFolderMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], ], ], 'DeleteFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteIdentityPropagationConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Service', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Service' => [ 'shape' => 'ServiceType', 'location' => 'uri', 'locationName' => 'Service', ], ], ], 'DeleteIdentityPropagationConfigResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'ScheduleId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ScheduleId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'ScheduleId', ], ], ], 'DeleteRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DeleteRoleMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteRoleMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DeleteTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DeleteThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DeleteThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DeleteTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], ], ], 'DeleteTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DeleteTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteUserByPrincipalIdRequest' => [ 'type' => 'structure', 'required' => [ 'PrincipalId', 'AwsAccountId', 'Namespace', ], 'members' => [ 'PrincipalId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'PrincipalId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteUserByPrincipalIdResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], ], ], 'DeleteVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'DeletionStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Delimiter' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'DescribeAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'Resolved' => [ 'shape' => 'boolean', 'location' => 'querystring', 'locationName' => 'resolved', ], ], ], 'DescribeAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeAccountSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'AccountSettings' => [ 'shape' => 'AccountSettings', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'AccountInfo' => [ 'shape' => 'AccountInfo', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Errors' => [ 'shape' => 'AnalysisErrorList', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AnalysisArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Analysis' => [ 'shape' => 'Analysis', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAssetBundleExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleExportJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AssetBundleExportJobId', ], ], ], 'DescribeAssetBundleExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleExportJobStatus', ], 'DownloadUrl' => [ 'shape' => 'SensitiveS3Uri', ], 'Errors' => [ 'shape' => 'AssetBundleExportJobErrorList', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'ResourceArns' => [ 'shape' => 'AssetBundleResourceArns', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'CloudFormationOverridePropertyConfiguration' => [ 'shape' => 'AssetBundleCloudFormationOverridePropertyConfiguration', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], 'ValidationStrategy' => [ 'shape' => 'AssetBundleExportJobValidationStrategy', ], 'Warnings' => [ 'shape' => 'AssetBundleExportJobWarningList', ], ], ], 'DescribeAssetBundleImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleImportJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AssetBundleImportJobId', ], ], ], 'DescribeAssetBundleImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleImportJobStatus', ], 'Errors' => [ 'shape' => 'AssetBundleImportJobErrorList', ], 'RollbackErrors' => [ 'shape' => 'AssetBundleImportJobErrorList', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'AssetBundleImportSource' => [ 'shape' => 'AssetBundleImportSourceDescription', ], 'OverrideParameters' => [ 'shape' => 'AssetBundleImportJobOverrideParameters', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'OverridePermissions' => [ 'shape' => 'AssetBundleImportJobOverridePermissions', ], 'OverrideTags' => [ 'shape' => 'AssetBundleImportJobOverrideTags', ], 'OverrideValidationStrategy' => [ 'shape' => 'AssetBundleImportJobOverrideValidationStrategy', ], 'Warnings' => [ 'shape' => 'AssetBundleImportJobWarningList', ], ], ], 'DescribeDashboardDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeDashboardDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Errors' => [ 'shape' => 'DashboardErrorList', ], 'Name' => [ 'shape' => 'DashboardName', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], ], ], 'DescribeDashboardPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], ], ], 'DescribeDashboardPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], ], ], 'DescribeDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'Dashboard', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeDashboardSnapshotJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'SnapshotJobId', ], ], ], 'DescribeDashboardSnapshotJobResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UserConfiguration' => [ 'shape' => 'SnapshotUserConfigurationRedacted', ], 'SnapshotConfiguration' => [ 'shape' => 'SnapshotConfiguration', ], 'Arn' => [ 'shape' => 'Arn', ], 'JobStatus' => [ 'shape' => 'SnapshotJobStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeDashboardSnapshotJobResultRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'SnapshotJobId', ], ], ], 'DescribeDashboardSnapshotJobResultResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'JobStatus' => [ 'shape' => 'SnapshotJobStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Result' => [ 'shape' => 'SnapshotJobResult', ], 'ErrorInfo' => [ 'shape' => 'SnapshotJobErrorInfo', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSetPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetArn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'DataSetRefreshProperties' => [ 'shape' => 'DataSetRefreshProperties', ], ], ], 'DescribeDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'DataSet' => [ 'shape' => 'DataSet', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSourcePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DescribeDataSourcePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DescribeDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSource' => [ 'shape' => 'DataSource', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeFolderPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'DescribeFolderPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], ], ], 'DescribeFolderResolvedPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'DescribeFolderResolvedPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Folder' => [ 'shape' => 'Folder', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMember' => [ 'shape' => 'GroupMember', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'IAMPolicyAssignment' => [ 'shape' => 'IAMPolicyAssignment', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'IngestionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], ], ], 'DescribeIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Ingestion' => [ 'shape' => 'Ingestion', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIpRestrictionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeIpRestrictionResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'IpRestrictionRuleMap' => [ 'shape' => 'IpRestrictionRuleMap', ], 'VpcIdRestrictionRuleMap' => [ 'shape' => 'VpcIdRestrictionRuleMap', ], 'VpcEndpointIdRestrictionRuleMap' => [ 'shape' => 'VpcEndpointIdRestrictionRuleMap', ], 'Enabled' => [ 'shape' => 'NullableBoolean', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeKeyRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DefaultKeyOnly' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'default-key-only', ], ], ], 'DescribeKeyRegistrationResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'KeyRegistration' => [ 'shape' => 'KeyRegistration', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'Namespace' => [ 'shape' => 'NamespaceInfoV2', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'ScheduleId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'ScheduleId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'ScheduleId', ], ], ], 'DescribeRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshSchedule' => [ 'shape' => 'RefreshSchedule', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DescribeTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTemplateDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeTemplateDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'TemplateName', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Errors' => [ 'shape' => 'TemplateErrorList', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTemplatePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], ], ], 'DescribeTemplatePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'Template' => [ 'shape' => 'Template', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DescribeThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeThemePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], ], ], 'DescribeThemePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAndAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Theme' => [ 'shape' => 'Theme', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DescribeTopicPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicRefreshRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'RefreshId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'RefreshId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'RefreshId', ], ], ], 'DescribeTopicRefreshResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshDetails' => [ 'shape' => 'TopicRefreshDetails', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], ], ], 'DescribeTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DescribeTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], ], ], 'DescribeVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'VPCConnection' => [ 'shape' => 'VPCConnection', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DestinationParameterValueConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomValuesConfiguration' => [ 'shape' => 'CustomValuesConfiguration', ], 'SelectAllValueOptions' => [ 'shape' => 'SelectAllValueOptions', ], 'SourceParameterName' => [ 'shape' => 'String', ], 'SourceField' => [ 'shape' => 'FieldId', ], 'SourceColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'DimensionField' => [ 'type' => 'structure', 'members' => [ 'NumericalDimensionField' => [ 'shape' => 'NumericalDimensionField', ], 'CategoricalDimensionField' => [ 'shape' => 'CategoricalDimensionField', ], 'DateDimensionField' => [ 'shape' => 'DateDimensionField', ], ], ], 'DimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 200, ], 'DisplayFormat' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'PERCENT', 'CURRENCY', 'NUMBER', 'DATE', 'STRING', ], ], 'DisplayFormatOptions' => [ 'type' => 'structure', 'members' => [ 'UseBlankCellFormat' => [ 'shape' => 'Boolean', ], 'BlankCellFormat' => [ 'shape' => 'LimitedString', ], 'DateFormat' => [ 'shape' => 'LimitedString', ], 'DecimalSeparator' => [ 'shape' => 'TopicNumericSeparatorSymbol', ], 'GroupingSeparator' => [ 'shape' => 'LimitedString', ], 'UseGrouping' => [ 'shape' => 'Boolean', ], 'FractionDigits' => [ 'shape' => 'Integer', ], 'Prefix' => [ 'shape' => 'LimitedString', ], 'Suffix' => [ 'shape' => 'LimitedString', ], 'UnitScaler' => [ 'shape' => 'NumberScale', ], 'NegativeFormat' => [ 'shape' => 'NegativeFormat', ], 'CurrencySymbol' => [ 'shape' => 'LimitedString', ], ], ], 'DnsResolverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPv4Address', ], 'max' => 15, ], 'Domain' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainNotWhitelistedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'DonutCenterOptions' => [ 'type' => 'structure', 'members' => [ 'LabelVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DonutOptions' => [ 'type' => 'structure', 'members' => [ 'ArcOptions' => [ 'shape' => 'ArcOptions', ], 'DonutCenterOptions' => [ 'shape' => 'DonutCenterOptions', ], ], ], 'Double' => [ 'type' => 'double', ], 'DrillDownFilter' => [ 'type' => 'structure', 'members' => [ 'NumericEqualityFilter' => [ 'shape' => 'NumericEqualityDrillDownFilter', ], 'CategoryFilter' => [ 'shape' => 'CategoryDrillDownFilter', ], 'TimeRangeFilter' => [ 'shape' => 'TimeRangeDrillDownFilter', ], ], ], 'DrillDownFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DrillDownFilter', ], 'max' => 10, ], 'DropDownControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'SelectAllOptions' => [ 'shape' => 'ListControlSelectAllOptions', ], 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'DynamicDefaultValue' => [ 'type' => 'structure', 'required' => [ 'DefaultValueColumn', ], 'members' => [ 'UserNameColumn' => [ 'shape' => 'ColumnIdentifier', ], 'GroupNameColumn' => [ 'shape' => 'ColumnIdentifier', ], 'DefaultValueColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'Edition' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'ENTERPRISE', 'ENTERPRISE_AND_Q', ], ], 'EmbeddingIdentityType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'QUICKSIGHT', 'ANONYMOUS', ], ], 'EmbeddingUrl' => [ 'type' => 'string', 'sensitive' => true, ], 'EmptyVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Entity' => [ 'type' => 'structure', 'members' => [ 'Path' => [ 'shape' => 'NonEmptyString', ], ], ], 'EntityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Entity', ], 'max' => 200, ], 'EntryPath' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'EntryPoint' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ErrorInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'IngestionErrorType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ExasolParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], ], ], 'ExceptionResourceType' => [ 'type' => 'string', 'enum' => [ 'USER', 'GROUP', 'NAMESPACE', 'ACCOUNT_SETTINGS', 'IAMPOLICY_ASSIGNMENT', 'DATA_SOURCE', 'DATA_SET', 'VPC_CONNECTION', 'INGESTION', ], ], 'ExcludePeriodConfiguration' => [ 'type' => 'structure', 'required' => [ 'Amount', 'Granularity', ], 'members' => [ 'Amount' => [ 'shape' => 'Integer', 'box' => true, ], 'Granularity' => [ 'shape' => 'TimeGranularity', ], 'Status' => [ 'shape' => 'WidgetStatus', ], ], ], 'ExplicitHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', 'Columns', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'Columns' => [ 'shape' => 'ExplicitHierarchyColumnList', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'ExplicitHierarchyColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, 'min' => 2, ], 'ExportHiddenFieldsOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ExportToCSVOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ExportWithHiddenFieldsOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'Expression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'sensitive' => true, ], 'FailedKeyRegistrationEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedKeyRegistrationEntry', ], ], 'FailedKeyRegistrationEntry' => [ 'type' => 'structure', 'required' => [ 'Message', 'StatusCode', 'SenderFault', ], 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'StatusCode' => [ 'shape' => 'StatusCode', ], 'SenderFault' => [ 'shape' => 'Boolean', ], ], ], 'FieldBasedTooltip' => [ 'type' => 'structure', 'members' => [ 'AggregationVisibility' => [ 'shape' => 'Visibility', ], 'TooltipTitleType' => [ 'shape' => 'TooltipTitleType', ], 'TooltipFields' => [ 'shape' => 'TooltipItemList', ], ], ], 'FieldFolder' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'FieldFolderDescription', ], 'columns' => [ 'shape' => 'FolderColumnList', ], ], ], 'FieldFolderDescription' => [ 'type' => 'string', 'max' => 500, ], 'FieldFolderMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FieldFolderPath', ], 'value' => [ 'shape' => 'FieldFolder', ], ], 'FieldFolderPath' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'FieldId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'FieldLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'FieldOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 200, ], 'FieldSeriesItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'AxisBinding', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'Settings' => [ 'shape' => 'LineChartSeriesSettings', ], ], ], 'FieldSort' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Direction', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Direction' => [ 'shape' => 'SortDirection', ], ], ], 'FieldSortOptions' => [ 'type' => 'structure', 'members' => [ 'FieldSort' => [ 'shape' => 'FieldSort', ], 'ColumnSort' => [ 'shape' => 'ColumnSort', ], ], ], 'FieldSortOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldSortOptions', ], 'max' => 100, ], 'FieldTooltipItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Label' => [ 'shape' => 'String', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'TooltipTarget' => [ 'shape' => 'TooltipTarget', ], ], ], 'FieldValue' => [ 'type' => 'string', 'max' => 2048, 'sensitive' => true, ], 'FileFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', 'TSV', 'CLF', 'ELF', 'XLSX', 'JSON', ], ], 'FilledMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Geospatial' => [ 'shape' => 'FilledMapDimensionFieldList', ], 'Values' => [ 'shape' => 'FilledMapMeasureFieldList', ], ], ], 'FilledMapConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'ConditionalFormattingOptions', ], 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'FilledMapConditionalFormattingOptionList', ], ], ], 'FilledMapConditionalFormattingOption' => [ 'type' => 'structure', 'required' => [ 'Shape', ], 'members' => [ 'Shape' => [ 'shape' => 'FilledMapShapeConditionalFormatting', ], ], ], 'FilledMapConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilledMapConditionalFormattingOption', ], 'max' => 200, ], 'FilledMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'FilledMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'FilledMapSortConfiguration', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'WindowOptions' => [ 'shape' => 'GeospatialWindowOptions', ], 'MapStyleOptions' => [ 'shape' => 'GeospatialMapStyleOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'FilledMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'FilledMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'FilledMapAggregatedFieldWells' => [ 'shape' => 'FilledMapAggregatedFieldWells', ], ], ], 'FilledMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'FilledMapShapeConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Format' => [ 'shape' => 'ShapeConditionalFormat', ], ], ], 'FilledMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'FilledMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'FilledMapConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'FilledMapConditionalFormatting', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'CategoryFilter' => [ 'shape' => 'CategoryFilter', ], 'NumericRangeFilter' => [ 'shape' => 'NumericRangeFilter', ], 'NumericEqualityFilter' => [ 'shape' => 'NumericEqualityFilter', ], 'TimeEqualityFilter' => [ 'shape' => 'TimeEqualityFilter', ], 'TimeRangeFilter' => [ 'shape' => 'TimeRangeFilter', ], 'RelativeDatesFilter' => [ 'shape' => 'RelativeDatesFilter', ], 'TopBottomFilter' => [ 'shape' => 'TopBottomFilter', ], 'NestedFilter' => [ 'shape' => 'NestedFilter', ], ], ], 'FilterAggMetrics' => [ 'type' => 'structure', 'members' => [ 'MetricOperand' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'AggType', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], ], ], 'FilterAggMetricsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterAggMetrics', ], 'max' => 100, ], 'FilterClass' => [ 'type' => 'string', 'enum' => [ 'ENFORCED_VALUE_FILTER', 'CONDITIONAL_VALUE_FILTER', 'NAMED_VALUE_FILTER', ], ], 'FilterControl' => [ 'type' => 'structure', 'members' => [ 'DateTimePicker' => [ 'shape' => 'FilterDateTimePickerControl', ], 'List' => [ 'shape' => 'FilterListControl', ], 'Dropdown' => [ 'shape' => 'FilterDropDownControl', ], 'TextField' => [ 'shape' => 'FilterTextFieldControl', ], 'TextArea' => [ 'shape' => 'FilterTextAreaControl', ], 'Slider' => [ 'shape' => 'FilterSliderControl', ], 'RelativeDateTime' => [ 'shape' => 'FilterRelativeDateTimeControl', ], 'CrossSheet' => [ 'shape' => 'FilterCrossSheetControl', ], ], ], 'FilterControlList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterControl', ], 'max' => 200, ], 'FilterCrossSheetControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterDateTimePickerControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlDateTimePickerType', ], ], ], 'FilterDropDownControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterGroup' => [ 'type' => 'structure', 'required' => [ 'FilterGroupId', 'Filters', 'ScopeConfiguration', 'CrossDataset', ], 'members' => [ 'FilterGroupId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Filters' => [ 'shape' => 'FilterList', ], 'ScopeConfiguration' => [ 'shape' => 'FilterScopeConfiguration', ], 'Status' => [ 'shape' => 'WidgetStatus', ], 'CrossDataset' => [ 'shape' => 'CrossDatasetTypes', ], ], ], 'FilterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterGroup', ], 'max' => 2000, ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, ], 'FilterListConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'FilterListControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterNullOption' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', 'NULLS_ONLY', 'NON_NULLS_ONLY', ], ], 'FilterOperation' => [ 'type' => 'structure', 'required' => [ 'ConditionExpression', ], 'members' => [ 'ConditionExpression' => [ 'shape' => 'Expression', ], ], ], 'FilterOperationSelectedFieldsConfiguration' => [ 'type' => 'structure', 'members' => [ 'SelectedFields' => [ 'shape' => 'SelectedFieldList', ], 'SelectedFieldOptions' => [ 'shape' => 'SelectedFieldOptions', ], 'SelectedColumns' => [ 'shape' => 'CustomActionColumnList', ], ], ], 'FilterOperationTargetVisualsConfiguration' => [ 'type' => 'structure', 'members' => [ 'SameSheetTargetVisualConfiguration' => [ 'shape' => 'SameSheetTargetVisualConfiguration', ], ], ], 'FilterOperator' => [ 'type' => 'string', 'enum' => [ 'StringEquals', 'StringLike', ], ], 'FilterRelativeDateTimeControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'RelativeDateTimeControlDisplayOptions', ], ], ], 'FilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [ 'SelectedSheets' => [ 'shape' => 'SelectedSheetsFilterScopeConfiguration', ], 'AllSheets' => [ 'shape' => 'AllSheetsFilterScopeConfiguration', ], ], ], 'FilterSelectableValues' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'ParameterSelectableValueList', ], ], ], 'FilterSliderControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlSliderType', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'FilterTextAreaControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'FilterTextFieldControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'FilterVisualScope' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', 'SELECTED_VISUALS', ], ], 'FilteredVisualsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 50, ], 'Folder' => [ 'type' => 'structure', 'members' => [ 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'FolderPath' => [ 'shape' => 'Path', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'FolderArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 1, ], 'FolderColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 5000, ], 'FolderFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'PARENT_FOLDER_ARN', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'FOLDER_NAME', ], ], 'FolderMember' => [ 'type' => 'structure', 'members' => [ 'MemberId' => [ 'shape' => 'RestrictiveResourceId', ], 'MemberType' => [ 'shape' => 'MemberType', ], ], ], 'FolderMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberIdArnPair', ], 'max' => 100, ], 'FolderName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'FolderSearchFilter' => [ 'type' => 'structure', 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'FolderFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'FolderSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderSearchFilter', ], 'max' => 100, ], 'FolderSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'FolderSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderSummary', ], 'max' => 100, ], 'FolderType' => [ 'type' => 'string', 'enum' => [ 'SHARED', 'RESTRICTED', ], ], 'Font' => [ 'type' => 'structure', 'members' => [ 'FontFamily' => [ 'shape' => 'String', ], ], ], 'FontConfiguration' => [ 'type' => 'structure', 'members' => [ 'FontSize' => [ 'shape' => 'FontSize', ], 'FontDecoration' => [ 'shape' => 'FontDecoration', ], 'FontColor' => [ 'shape' => 'HexColor', ], 'FontWeight' => [ 'shape' => 'FontWeight', ], 'FontStyle' => [ 'shape' => 'FontStyle', ], ], ], 'FontDecoration' => [ 'type' => 'string', 'enum' => [ 'UNDERLINE', 'NONE', ], ], 'FontList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Font', ], 'max' => 5, ], 'FontSize' => [ 'type' => 'structure', 'members' => [ 'Relative' => [ 'shape' => 'RelativeFontSize', ], ], ], 'FontStyle' => [ 'type' => 'string', 'enum' => [ 'NORMAL', 'ITALIC', ], ], 'FontWeight' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FontWeightName', ], ], ], 'FontWeightName' => [ 'type' => 'string', 'enum' => [ 'NORMAL', 'BOLD', ], ], 'ForecastComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodsForward' => [ 'shape' => 'PeriodsForward', ], 'PeriodsBackward' => [ 'shape' => 'PeriodsBackward', ], 'UpperBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'LowerBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'PredictionInterval' => [ 'shape' => 'PredictionInterval', ], 'Seasonality' => [ 'shape' => 'ForecastComputationSeasonality', ], 'CustomSeasonalityValue' => [ 'shape' => 'ForecastComputationCustomSeasonalityValue', 'box' => true, ], ], ], 'ForecastComputationCustomSeasonalityValue' => [ 'type' => 'integer', 'max' => 180, 'min' => 1, ], 'ForecastComputationSeasonality' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC', 'CUSTOM', ], ], 'ForecastConfiguration' => [ 'type' => 'structure', 'members' => [ 'ForecastProperties' => [ 'shape' => 'TimeBasedForecastProperties', ], 'Scenario' => [ 'shape' => 'ForecastScenario', ], ], ], 'ForecastConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastConfiguration', ], 'max' => 10, ], 'ForecastScenario' => [ 'type' => 'structure', 'members' => [ 'WhatIfPointScenario' => [ 'shape' => 'WhatIfPointScenario', ], 'WhatIfRangeScenario' => [ 'shape' => 'WhatIfRangeScenario', ], ], ], 'FormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'StringFormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], 'NumberFormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], 'DateTimeFormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'FreeFormLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'ScreenCanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutScreenCanvasSizeOptions', ], ], ], 'FreeFormLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'FreeFromLayoutElementList', ], 'CanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutCanvasSizeOptions', ], ], ], 'FreeFormLayoutElement' => [ 'type' => 'structure', 'required' => [ 'ElementId', 'ElementType', 'XAxisLocation', 'YAxisLocation', 'Width', 'Height', ], 'members' => [ 'ElementId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ElementType' => [ 'shape' => 'LayoutElementType', ], 'XAxisLocation' => [ 'shape' => 'PixelLength', ], 'YAxisLocation' => [ 'shape' => 'UnlimitedPixelLength', ], 'Width' => [ 'shape' => 'PixelLength', ], 'Height' => [ 'shape' => 'PixelLength', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'RenderingRules' => [ 'shape' => 'SheetElementRenderingRuleList', ], 'BorderStyle' => [ 'shape' => 'FreeFormLayoutElementBorderStyle', ], 'SelectedBorderStyle' => [ 'shape' => 'FreeFormLayoutElementBorderStyle', ], 'BackgroundStyle' => [ 'shape' => 'FreeFormLayoutElementBackgroundStyle', ], 'LoadingAnimation' => [ 'shape' => 'LoadingAnimation', ], ], ], 'FreeFormLayoutElementBackgroundStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Color' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'FreeFormLayoutElementBorderStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Color' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'FreeFormLayoutScreenCanvasSizeOptions' => [ 'type' => 'structure', 'required' => [ 'OptimizedViewPortWidth', ], 'members' => [ 'OptimizedViewPortWidth' => [ 'shape' => 'PixelLength', 'box' => true, ], ], ], 'FreeFormSectionLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'FreeFromLayoutElementList', ], ], ], 'FreeFromLayoutElementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FreeFormLayoutElement', ], 'max' => 430, ], 'FunnelChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'FunnelChartDimensionFieldList', ], 'Values' => [ 'shape' => 'FunnelChartMeasureFieldList', ], ], ], 'FunnelChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'FunnelChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'FunnelChartSortConfiguration', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'DataLabelOptions' => [ 'shape' => 'FunnelChartDataLabelOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'FunnelChartDataLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CategoryLabelVisibility' => [ 'shape' => 'Visibility', ], 'MeasureLabelVisibility' => [ 'shape' => 'Visibility', ], 'Position' => [ 'shape' => 'DataLabelPosition', ], 'LabelFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'LabelColor' => [ 'shape' => 'HexColor', ], 'MeasureDataLabelStyle' => [ 'shape' => 'FunnelChartMeasureDataLabelStyle', ], ], ], 'FunnelChartDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'FunnelChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'FunnelChartAggregatedFieldWells' => [ 'shape' => 'FunnelChartAggregatedFieldWells', ], ], ], 'FunnelChartMeasureDataLabelStyle' => [ 'type' => 'string', 'enum' => [ 'VALUE_ONLY', 'PERCENTAGE_BY_FIRST_STAGE', 'PERCENTAGE_BY_PREVIOUS_STAGE', 'VALUE_AND_PERCENTAGE_BY_FIRST_STAGE', 'VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE', ], ], 'FunnelChartMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'FunnelChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'FunnelChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'FunnelChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'GaugeChartArcConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'GaugeChartColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'HexColor', ], 'BackgroundColor' => [ 'shape' => 'HexColor', ], ], ], 'GaugeChartConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'GaugeChartConditionalFormattingOptionList', ], ], ], 'GaugeChartConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'PrimaryValue' => [ 'shape' => 'GaugeChartPrimaryValueConditionalFormatting', ], 'Arc' => [ 'shape' => 'GaugeChartArcConditionalFormatting', ], ], ], 'GaugeChartConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GaugeChartConditionalFormattingOption', ], 'max' => 100, ], 'GaugeChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'GaugeChartFieldWells', ], 'GaugeChartOptions' => [ 'shape' => 'GaugeChartOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'TooltipOptions' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ColorConfiguration' => [ 'shape' => 'GaugeChartColorConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'GaugeChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'MeasureFieldList', ], 'TargetValues' => [ 'shape' => 'MeasureFieldList', ], ], ], 'GaugeChartOptions' => [ 'type' => 'structure', 'members' => [ 'PrimaryValueDisplayType' => [ 'shape' => 'PrimaryValueDisplayType', ], 'Comparison' => [ 'shape' => 'ComparisonConfiguration', ], 'ArcAxis' => [ 'shape' => 'ArcAxisConfiguration', ], 'Arc' => [ 'shape' => 'ArcConfiguration', ], 'PrimaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], ], ], 'GaugeChartPrimaryValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'GaugeChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'GaugeChartConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'GaugeChartConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'GenerateEmbedUrlForAnonymousUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'AuthorizedResourceArns', 'ExperienceConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'SessionTags' => [ 'shape' => 'SessionTagList', ], 'AuthorizedResourceArns' => [ 'shape' => 'ArnList', ], 'ExperienceConfiguration' => [ 'shape' => 'AnonymousUserEmbeddingExperienceConfiguration', ], 'AllowedDomains' => [ 'shape' => 'StringList', ], ], ], 'GenerateEmbedUrlForAnonymousUserResponse' => [ 'type' => 'structure', 'required' => [ 'EmbedUrl', 'Status', 'RequestId', 'AnonymousUserArn', ], 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'AnonymousUserArn' => [ 'shape' => 'Arn', ], ], ], 'GenerateEmbedUrlForRegisteredUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'UserArn', 'ExperienceConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', ], 'UserArn' => [ 'shape' => 'Arn', ], 'ExperienceConfiguration' => [ 'shape' => 'RegisteredUserEmbeddingExperienceConfiguration', ], 'AllowedDomains' => [ 'shape' => 'StringList', ], ], ], 'GenerateEmbedUrlForRegisteredUserResponse' => [ 'type' => 'structure', 'required' => [ 'EmbedUrl', 'Status', 'RequestId', ], 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GeoSpatialColumnGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Columns', ], 'members' => [ 'Name' => [ 'shape' => 'ColumnGroupName', ], 'CountryCode' => [ 'shape' => 'GeoSpatialCountryCode', ], 'Columns' => [ 'shape' => 'ColumnList', ], ], ], 'GeoSpatialCountryCode' => [ 'type' => 'string', 'enum' => [ 'US', ], ], 'GeoSpatialDataRole' => [ 'type' => 'string', 'enum' => [ 'COUNTRY', 'STATE', 'COUNTY', 'CITY', 'POSTCODE', 'LONGITUDE', 'LATITUDE', ], ], 'GeospatialCoordinateBounds' => [ 'type' => 'structure', 'required' => [ 'North', 'South', 'West', 'East', ], 'members' => [ 'North' => [ 'shape' => 'Latitude', ], 'South' => [ 'shape' => 'Latitude', ], 'West' => [ 'shape' => 'Longitude', ], 'East' => [ 'shape' => 'Longitude', ], ], ], 'GeospatialHeatmapColorScale' => [ 'type' => 'structure', 'members' => [ 'Colors' => [ 'shape' => 'GeospatialHeatmapDataColorList', ], ], ], 'GeospatialHeatmapConfiguration' => [ 'type' => 'structure', 'members' => [ 'HeatmapColor' => [ 'shape' => 'GeospatialHeatmapColorScale', ], ], ], 'GeospatialHeatmapDataColor' => [ 'type' => 'structure', 'required' => [ 'Color', ], 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], ], ], 'GeospatialHeatmapDataColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GeospatialHeatmapDataColor', ], 'max' => 2, 'min' => 2, ], 'GeospatialMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Geospatial' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], ], ], 'GeospatialMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'GeospatialMapFieldWells', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'WindowOptions' => [ 'shape' => 'GeospatialWindowOptions', ], 'MapStyleOptions' => [ 'shape' => 'GeospatialMapStyleOptions', ], 'PointStyleOptions' => [ 'shape' => 'GeospatialPointStyleOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'GeospatialMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'GeospatialMapAggregatedFieldWells' => [ 'shape' => 'GeospatialMapAggregatedFieldWells', ], ], ], 'GeospatialMapStyleOptions' => [ 'type' => 'structure', 'members' => [ 'BaseMapStyle' => [ 'shape' => 'BaseMapStyleType', ], ], ], 'GeospatialMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'GeospatialMapConfiguration', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'GeospatialPointStyleOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedPointStyle' => [ 'shape' => 'GeospatialSelectedPointStyle', ], 'ClusterMarkerConfiguration' => [ 'shape' => 'ClusterMarkerConfiguration', ], 'HeatmapConfiguration' => [ 'shape' => 'GeospatialHeatmapConfiguration', ], ], ], 'GeospatialSelectedPointStyle' => [ 'type' => 'string', 'enum' => [ 'POINT', 'CLUSTER', 'HEATMAP', ], ], 'GeospatialWindowOptions' => [ 'type' => 'structure', 'members' => [ 'Bounds' => [ 'shape' => 'GeospatialCoordinateBounds', ], 'MapZoomMode' => [ 'shape' => 'MapZoomMode', ], ], ], 'GetDashboardEmbedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'IdentityType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'IdentityType' => [ 'shape' => 'EmbeddingIdentityType', 'location' => 'querystring', 'locationName' => 'creds-type', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', 'location' => 'querystring', 'locationName' => 'session-lifetime', ], 'UndoRedoDisabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'undo-redo-disabled', ], 'ResetDisabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'reset-disabled', ], 'StatePersistenceEnabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'state-persistence-enabled', ], 'UserArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'user-arn', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AdditionalDashboardIds' => [ 'shape' => 'AdditionalDashboardIdList', 'location' => 'querystring', 'locationName' => 'additional-dashboard-ids', ], ], ], 'GetDashboardEmbedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GetSessionEmbedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'EntryPoint' => [ 'shape' => 'EntryPoint', 'location' => 'querystring', 'locationName' => 'entry-point', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', 'location' => 'querystring', 'locationName' => 'session-lifetime', ], 'UserArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'user-arn', ], ], ], 'GetSessionEmbedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GlobalTableBorderOptions' => [ 'type' => 'structure', 'members' => [ 'UniformBorder' => [ 'shape' => 'TableBorderOptions', ], 'SideSpecificBorder' => [ 'shape' => 'TableSideBorderOptions', ], ], ], 'GradientColor' => [ 'type' => 'structure', 'members' => [ 'Stops' => [ 'shape' => 'GradientStopList', ], ], ], 'GradientStop' => [ 'type' => 'structure', 'required' => [ 'GradientOffset', ], 'members' => [ 'GradientOffset' => [ 'shape' => 'Double', ], 'DataValue' => [ 'shape' => 'Double', 'box' => true, ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'GradientStopList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GradientStop', ], 'max' => 100, ], 'GridLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'ScreenCanvasSizeOptions' => [ 'shape' => 'GridLayoutScreenCanvasSizeOptions', ], ], ], 'GridLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'GridLayoutElementList', ], 'CanvasSizeOptions' => [ 'shape' => 'GridLayoutCanvasSizeOptions', ], ], ], 'GridLayoutElement' => [ 'type' => 'structure', 'required' => [ 'ElementId', 'ElementType', 'ColumnSpan', 'RowSpan', ], 'members' => [ 'ElementId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ElementType' => [ 'shape' => 'LayoutElementType', ], 'ColumnIndex' => [ 'shape' => 'GridLayoutElementColumnIndex', ], 'ColumnSpan' => [ 'shape' => 'GridLayoutElementColumnSpan', ], 'RowIndex' => [ 'shape' => 'GridLayoutElementRowIndex', ], 'RowSpan' => [ 'shape' => 'GridLayoutElementRowSpan', ], ], ], 'GridLayoutElementColumnIndex' => [ 'type' => 'integer', 'max' => 35, 'min' => 0, ], 'GridLayoutElementColumnSpan' => [ 'type' => 'integer', 'max' => 36, 'min' => 1, ], 'GridLayoutElementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GridLayoutElement', ], 'max' => 430, ], 'GridLayoutElementRowIndex' => [ 'type' => 'integer', 'max' => 9009, 'min' => 0, ], 'GridLayoutElementRowSpan' => [ 'type' => 'integer', 'max' => 21, 'min' => 1, ], 'GridLayoutScreenCanvasSizeOptions' => [ 'type' => 'structure', 'required' => [ 'ResizeOption', ], 'members' => [ 'ResizeOption' => [ 'shape' => 'ResizeOption', ], 'OptimizedViewPortWidth' => [ 'shape' => 'PixelLength', 'box' => true, ], ], ], 'Group' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'GroupName' => [ 'shape' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'PrincipalId' => [ 'shape' => 'String', ], ], ], 'GroupDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'GroupFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'GROUP_NAME', ], ], 'GroupFilterOperator' => [ 'type' => 'string', 'enum' => [ 'StartsWith', ], ], 'GroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], ], 'GroupMember' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'MemberName' => [ 'shape' => 'GroupMemberName', ], ], ], 'GroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupMember', ], ], 'GroupMemberName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'GroupName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'GroupSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'GroupFilterOperator', ], 'Name' => [ 'shape' => 'GroupFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'GroupSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupSearchFilter', ], 'max' => 1, 'min' => 1, ], 'GroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'GrowthRateComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodSize' => [ 'shape' => 'GrowthRatePeriodSize', ], ], ], 'GrowthRatePeriodSize' => [ 'type' => 'integer', 'max' => 52, 'min' => 2, ], 'GutterStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'HeaderFooterSectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'SectionId', 'Layout', ], 'members' => [ 'SectionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], 'Style' => [ 'shape' => 'SectionStyle', ], ], ], 'HeaderFooterSectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HeaderFooterSectionConfiguration', ], 'max' => 1, ], 'HeatMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Rows' => [ 'shape' => 'HeatMapDimensionFieldList', ], 'Columns' => [ 'shape' => 'HeatMapDimensionFieldList', ], 'Values' => [ 'shape' => 'HeatMapMeasureFieldList', ], ], ], 'HeatMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'HeatMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'HeatMapSortConfiguration', ], 'RowLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColumnLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorScale' => [ 'shape' => 'ColorScale', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'HeatMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'HeatMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'HeatMapAggregatedFieldWells' => [ 'shape' => 'HeatMapAggregatedFieldWells', ], ], ], 'HeatMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'HeatMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'HeatMapRowSort' => [ 'shape' => 'FieldSortOptionsList', ], 'HeatMapColumnSort' => [ 'shape' => 'FieldSortOptionsList', ], 'HeatMapRowItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'HeatMapColumnItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'HeatMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'HeatMapConfiguration', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'HexColor' => [ 'type' => 'string', 'pattern' => '^#[A-F0-9]{6}$', ], 'HexColorWithTransparency' => [ 'type' => 'string', 'pattern' => '^#[A-F0-9]{6}(?:[A-F0-9]{2})?$', ], 'HierarchyId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'HistogramAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'HistogramMeasureFieldList', ], ], ], 'HistogramBinOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedBinType' => [ 'shape' => 'HistogramBinType', ], 'BinCount' => [ 'shape' => 'BinCountOptions', ], 'BinWidth' => [ 'shape' => 'BinWidthOptions', ], 'StartValue' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'HistogramBinType' => [ 'type' => 'string', 'enum' => [ 'BIN_COUNT', 'BIN_WIDTH', ], ], 'HistogramConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'HistogramFieldWells', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'YAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'BinOptions' => [ 'shape' => 'HistogramBinOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'HistogramFieldWells' => [ 'type' => 'structure', 'members' => [ 'HistogramAggregatedFieldWells' => [ 'shape' => 'HistogramAggregatedFieldWells', ], ], ], 'HistogramMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'HistogramVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'HistogramConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'HorizontalTextAlignment' => [ 'type' => 'string', 'enum' => [ 'LEFT', 'CENTER', 'RIGHT', 'AUTO', ], ], 'Host' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'IAMPolicyAssignment' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'AssignmentId' => [ 'shape' => 'String', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], ], ], 'IAMPolicyAssignmentName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$', ], 'IAMPolicyAssignmentSummary' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], ], ], 'IAMPolicyAssignmentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IAMPolicyAssignmentSummary', ], ], 'IPv4Address' => [ 'type' => 'string', 'max' => 15, 'min' => 7, ], 'Icon' => [ 'type' => 'string', 'enum' => [ 'CARET_UP', 'CARET_DOWN', 'PLUS', 'MINUS', 'ARROW_UP', 'ARROW_DOWN', 'ARROW_LEFT', 'ARROW_UP_LEFT', 'ARROW_DOWN_LEFT', 'ARROW_RIGHT', 'ARROW_UP_RIGHT', 'ARROW_DOWN_RIGHT', 'FACE_UP', 'FACE_DOWN', 'FACE_FLAT', 'ONE_BAR', 'TWO_BAR', 'THREE_BAR', 'CIRCLE', 'TRIANGLE', 'SQUARE', 'FLAG', 'THUMBS_UP', 'THUMBS_DOWN', 'CHECKMARK', 'X', ], ], 'Identifier' => [ 'type' => 'structure', 'required' => [ 'Identity', ], 'members' => [ 'Identity' => [ 'shape' => 'LimitedString', ], ], ], 'IdentityCenterConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableIdentityPropagation' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'IdentityMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'IdentityNameList', ], ], 'IdentityName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'IdentityNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityName', ], ], 'IdentityStore' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT', ], ], 'IdentityType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'QUICKSIGHT', 'IAM_IDENTITY_CENTER', ], ], 'IdentityTypeNotSupportedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'IncrementalRefresh' => [ 'type' => 'structure', 'required' => [ 'LookbackWindow', ], 'members' => [ 'LookbackWindow' => [ 'shape' => 'LookbackWindow', ], ], ], 'Ingestion' => [ 'type' => 'structure', 'required' => [ 'Arn', 'IngestionStatus', 'CreatedTime', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'IngestionStatus' => [ 'shape' => 'IngestionStatus', ], 'ErrorInfo' => [ 'shape' => 'ErrorInfo', ], 'RowInfo' => [ 'shape' => 'RowInfo', ], 'QueueInfo' => [ 'shape' => 'QueueInfo', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'IngestionTimeInSeconds' => [ 'shape' => 'Long', 'box' => true, ], 'IngestionSizeInBytes' => [ 'shape' => 'Long', 'box' => true, ], 'RequestSource' => [ 'shape' => 'IngestionRequestSource', ], 'RequestType' => [ 'shape' => 'IngestionRequestType', ], ], ], 'IngestionErrorType' => [ 'type' => 'string', 'enum' => [ 'FAILURE_TO_ASSUME_ROLE', 'INGESTION_SUPERSEDED', 'INGESTION_CANCELED', 'DATA_SET_DELETED', 'DATA_SET_NOT_SPICE', 'S3_UPLOADED_FILE_DELETED', 'S3_MANIFEST_ERROR', 'DATA_TOLERANCE_EXCEPTION', 'SPICE_TABLE_NOT_FOUND', 'DATA_SET_SIZE_LIMIT_EXCEEDED', 'ROW_SIZE_LIMIT_EXCEEDED', 'ACCOUNT_CAPACITY_LIMIT_EXCEEDED', 'CUSTOMER_ERROR', 'DATA_SOURCE_NOT_FOUND', 'IAM_ROLE_NOT_AVAILABLE', 'CONNECTION_FAILURE', 'SQL_TABLE_NOT_FOUND', 'PERMISSION_DENIED', 'SSL_CERTIFICATE_VALIDATION_FAILURE', 'OAUTH_TOKEN_FAILURE', 'SOURCE_API_LIMIT_EXCEEDED_FAILURE', 'PASSWORD_AUTHENTICATION_FAILURE', 'SQL_SCHEMA_MISMATCH_ERROR', 'INVALID_DATE_FORMAT', 'INVALID_DATAPREP_SYNTAX', 'SOURCE_RESOURCE_LIMIT_EXCEEDED', 'SQL_INVALID_PARAMETER_VALUE', 'QUERY_TIMEOUT', 'SQL_NUMERIC_OVERFLOW', 'UNRESOLVABLE_HOST', 'UNROUTABLE_HOST', 'SQL_EXCEPTION', 'S3_FILE_INACCESSIBLE', 'IOT_FILE_NOT_FOUND', 'IOT_DATA_SET_FILE_EMPTY', 'INVALID_DATA_SOURCE_CONFIG', 'DATA_SOURCE_AUTH_FAILED', 'DATA_SOURCE_CONNECTION_FAILED', 'FAILURE_TO_PROCESS_JSON_FILE', 'INTERNAL_SERVICE_ERROR', 'REFRESH_SUPPRESSED_BY_EDIT', 'PERMISSION_NOT_FOUND', 'ELASTICSEARCH_CURSOR_NOT_ENABLED', 'CURSOR_NOT_ENABLED', 'DUPLICATE_COLUMN_NAMES_FOUND', ], ], 'IngestionId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_]+$', ], 'IngestionMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'IngestionRequestSource' => [ 'type' => 'string', 'enum' => [ 'MANUAL', 'SCHEDULED', ], ], 'IngestionRequestType' => [ 'type' => 'string', 'enum' => [ 'INITIAL_INGESTION', 'EDIT', 'INCREMENTAL_REFRESH', 'FULL_REFRESH', ], ], 'IngestionStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'QUEUED', 'RUNNING', 'FAILED', 'COMPLETED', 'CANCELLED', ], ], 'IngestionType' => [ 'type' => 'string', 'enum' => [ 'INCREMENTAL_REFRESH', 'FULL_REFRESH', ], ], 'Ingestions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ingestion', ], ], 'InnerFilter' => [ 'type' => 'structure', 'members' => [ 'CategoryInnerFilter' => [ 'shape' => 'CategoryInnerFilter', ], ], ], 'InputColumn' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ColumnName', ], 'Type' => [ 'shape' => 'InputColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], ], ], 'InputColumnDataType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'INTEGER', 'DECIMAL', 'DATETIME', 'BIT', 'BOOLEAN', 'JSON', ], ], 'InputColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputColumn', ], 'max' => 2048, 'min' => 1, ], 'InsightConfiguration' => [ 'type' => 'structure', 'members' => [ 'Computations' => [ 'shape' => 'ComputationList', ], 'CustomNarrative' => [ 'shape' => 'CustomNarrativeOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'InsightVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'InsightConfiguration' => [ 'shape' => 'InsightConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], ], ], 'InstanceId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'IntegerDatasetParameterDefaultValues', ], ], ], 'IntegerDatasetParameterDefaultValue' => [ 'type' => 'long', ], 'IntegerDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'IntegerDatasetParameterValueList', ], ], ], 'IntegerDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'IntegerDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveLongObject', ], 'max' => 50000, ], 'IntegerDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'IntegerDefaultValueList', ], ], ], 'IntegerParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveLongList', ], ], ], 'IntegerParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'IntegerDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'IntegerValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'IntegerParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameter', ], 'max' => 100, ], 'IntegerValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveLong', 'box' => true, ], ], ], 'InternalFailureException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTopicReviewedAnswer' => [ 'type' => 'structure', 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], 'Error' => [ 'shape' => 'ReviewedAnswerErrorCode', ], ], ], 'InvalidTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvalidTopicReviewedAnswer', ], ], 'IpRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'IpRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CIDR', ], 'value' => [ 'shape' => 'IpRestrictionRuleDescription', ], ], 'ItemsLimitConfiguration' => [ 'type' => 'structure', 'members' => [ 'ItemsLimit' => [ 'shape' => 'Long', 'box' => true, ], 'OtherCategories' => [ 'shape' => 'OtherCategories', ], ], ], 'JiraParameters' => [ 'type' => 'structure', 'required' => [ 'SiteBaseUrl', ], 'members' => [ 'SiteBaseUrl' => [ 'shape' => 'SiteBaseUrl', ], ], ], 'JoinInstruction' => [ 'type' => 'structure', 'required' => [ 'LeftOperand', 'RightOperand', 'Type', 'OnClause', ], 'members' => [ 'LeftOperand' => [ 'shape' => 'LogicalTableId', ], 'RightOperand' => [ 'shape' => 'LogicalTableId', ], 'LeftJoinKeyProperties' => [ 'shape' => 'JoinKeyProperties', ], 'RightJoinKeyProperties' => [ 'shape' => 'JoinKeyProperties', ], 'Type' => [ 'shape' => 'JoinType', ], 'OnClause' => [ 'shape' => 'OnClause', ], ], ], 'JoinKeyProperties' => [ 'type' => 'structure', 'members' => [ 'UniqueKey' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'JoinType' => [ 'type' => 'string', 'enum' => [ 'INNER', 'OUTER', 'LEFT', 'RIGHT', ], ], 'KPIActualValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIComparisonValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'KPIConditionalFormattingOptionList', ], ], ], 'KPIConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'PrimaryValue' => [ 'shape' => 'KPIPrimaryValueConditionalFormatting', ], 'ProgressBar' => [ 'shape' => 'KPIProgressBarConditionalFormatting', ], 'ActualValue' => [ 'shape' => 'KPIActualValueConditionalFormatting', ], 'ComparisonValue' => [ 'shape' => 'KPIComparisonValueConditionalFormatting', ], ], ], 'KPIConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KPIConditionalFormattingOption', ], 'max' => 100, ], 'KPIConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'KPIFieldWells', ], 'SortConfiguration' => [ 'shape' => 'KPISortConfiguration', ], 'KPIOptions' => [ 'shape' => 'KPIOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'KPIFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'MeasureFieldList', ], 'TargetValues' => [ 'shape' => 'MeasureFieldList', ], 'TrendGroups' => [ 'shape' => 'DimensionFieldList', ], ], ], 'KPIOptions' => [ 'type' => 'structure', 'members' => [ 'ProgressBar' => [ 'shape' => 'ProgressBarOptions', ], 'TrendArrows' => [ 'shape' => 'TrendArrowOptions', ], 'SecondaryValue' => [ 'shape' => 'SecondaryValueOptions', ], 'Comparison' => [ 'shape' => 'ComparisonConfiguration', ], 'PrimaryValueDisplayType' => [ 'shape' => 'PrimaryValueDisplayType', ], 'PrimaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'SecondaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'Sparkline' => [ 'shape' => 'KPISparklineOptions', ], 'VisualLayoutOptions' => [ 'shape' => 'KPIVisualLayoutOptions', ], ], ], 'KPIPrimaryValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIProgressBarConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'KPISortConfiguration' => [ 'type' => 'structure', 'members' => [ 'TrendGroupSort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'KPISparklineOptions' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Type' => [ 'shape' => 'KPISparklineType', ], 'Color' => [ 'shape' => 'HexColor', ], 'TooltipVisibility' => [ 'shape' => 'Visibility', ], ], ], 'KPISparklineType' => [ 'type' => 'string', 'enum' => [ 'LINE', 'AREA', ], ], 'KPIVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'KPIConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'KPIConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'KPIVisualLayoutOptions' => [ 'type' => 'structure', 'members' => [ 'StandardLayout' => [ 'shape' => 'KPIVisualStandardLayout', ], ], ], 'KPIVisualStandardLayout' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'KPIVisualStandardLayoutType', ], ], ], 'KPIVisualStandardLayoutType' => [ 'type' => 'string', 'enum' => [ 'CLASSIC', 'VERTICAL', ], ], 'KeyRegistration' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegisteredCustomerManagedKey', ], ], 'LabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'CustomLabel' => [ 'shape' => 'String', ], ], ], 'Latitude' => [ 'type' => 'double', 'max' => 90, 'min' => -90, ], 'Layout' => [ 'type' => 'structure', 'required' => [ 'Configuration', ], 'members' => [ 'Configuration' => [ 'shape' => 'LayoutConfiguration', ], ], ], 'LayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'GridLayout' => [ 'shape' => 'GridLayoutConfiguration', ], 'FreeFormLayout' => [ 'shape' => 'FreeFormLayoutConfiguration', ], 'SectionBasedLayout' => [ 'shape' => 'SectionBasedLayoutConfiguration', ], ], ], 'LayoutElementType' => [ 'type' => 'string', 'enum' => [ 'VISUAL', 'FILTER_CONTROL', 'PARAMETER_CONTROL', 'TEXT_BOX', ], ], 'LayoutList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Layout', ], 'max' => 1, 'min' => 1, ], 'LegendOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Title' => [ 'shape' => 'LabelOptions', ], 'Position' => [ 'shape' => 'LegendPosition', ], 'Width' => [ 'shape' => 'PixelLength', ], 'Height' => [ 'shape' => 'PixelLength', ], ], ], 'LegendPosition' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'RIGHT', 'BOTTOM', 'TOP', ], ], 'Length' => [ 'type' => 'string', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitedString' => [ 'type' => 'string', 'max' => 256, ], 'LineChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'LineChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'LineChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'LineChartSortConfiguration', ], 'ForecastConfigurations' => [ 'shape' => 'ForecastConfigurationList', ], 'Type' => [ 'shape' => 'LineChartType', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'LineSeriesAxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SecondaryYAxisDisplayOptions' => [ 'shape' => 'LineSeriesAxisDisplayOptions', ], 'SecondaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SingleAxisOptions' => [ 'shape' => 'SingleAxisOptions', ], 'DefaultSeriesSettings' => [ 'shape' => 'LineChartDefaultSeriesSettings', ], 'Series' => [ 'shape' => 'SeriesItemList', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'LineChartDefaultSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'LineStyleSettings' => [ 'shape' => 'LineChartLineStyleSettings', ], 'MarkerStyleSettings' => [ 'shape' => 'LineChartMarkerStyleSettings', ], ], ], 'LineChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'LineChartAggregatedFieldWells' => [ 'shape' => 'LineChartAggregatedFieldWells', ], ], ], 'LineChartLineStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DOTTED', 'DASHED', ], ], 'LineChartLineStyleSettings' => [ 'type' => 'structure', 'members' => [ 'LineVisibility' => [ 'shape' => 'Visibility', ], 'LineInterpolation' => [ 'shape' => 'LineInterpolation', ], 'LineStyle' => [ 'shape' => 'LineChartLineStyle', ], 'LineWidth' => [ 'shape' => 'PixelLength', ], ], ], 'LineChartMarkerShape' => [ 'type' => 'string', 'enum' => [ 'CIRCLE', 'TRIANGLE', 'SQUARE', 'DIAMOND', 'ROUNDED_SQUARE', ], ], 'LineChartMarkerStyleSettings' => [ 'type' => 'structure', 'members' => [ 'MarkerVisibility' => [ 'shape' => 'Visibility', ], 'MarkerShape' => [ 'shape' => 'LineChartMarkerShape', ], 'MarkerSize' => [ 'shape' => 'PixelLength', ], 'MarkerColor' => [ 'shape' => 'HexColor', ], ], ], 'LineChartSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'LineStyleSettings' => [ 'shape' => 'LineChartLineStyleSettings', ], 'MarkerStyleSettings' => [ 'shape' => 'LineChartMarkerStyleSettings', ], ], ], 'LineChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'LineChartType' => [ 'type' => 'string', 'enum' => [ 'LINE', 'AREA', 'STACKED_AREA', ], ], 'LineChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'LineChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'LineInterpolation' => [ 'type' => 'string', 'enum' => [ 'LINEAR', 'SMOOTH', 'STEPPED', ], ], 'LineSeriesAxisDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'AxisOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'MissingDataConfigurations' => [ 'shape' => 'MissingDataConfigurationList', ], ], ], 'LinkEntityArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}', ], 'LinkEntityArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkEntityArn', ], 'max' => 5, ], 'LinkSharingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'ListAnalysesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAnalysesResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisSummaryList' => [ 'shape' => 'AnalysisSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListAssetBundleExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAssetBundleExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'AssetBundleExportJobSummaryList' => [ 'shape' => 'AssetBundleExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListAssetBundleImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAssetBundleImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'AssetBundleImportJobSummaryList' => [ 'shape' => 'AssetBundleImportJobSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'SearchOptions' => [ 'shape' => 'ListControlSearchOptions', ], 'SelectAllOptions' => [ 'shape' => 'ListControlSelectAllOptions', ], 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'ListControlSearchOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ListControlSelectAllOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ListDashboardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDashboardVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardVersionSummaryList' => [ 'shape' => 'DashboardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListDashboardsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDashboardsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardSummaryList' => [ 'shape' => 'DashboardSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListDataSetsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDataSetsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetSummaries' => [ 'shape' => 'DataSetSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListFolderMembersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListFolderMembersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderMemberList' => [ 'shape' => 'FolderMemberList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListFoldersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListFoldersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderSummaryList' => [ 'shape' => 'FolderSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListGroupMembershipsRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListGroupMembershipsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMemberList' => [ 'shape' => 'GroupMemberList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIAMPolicyAssignmentsForUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'UserName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListIAMPolicyAssignmentsForUserResponse' => [ 'type' => 'structure', 'members' => [ 'ActiveAssignments' => [ 'shape' => 'ActiveIAMPolicyAssignmentList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIAMPolicyAssignmentsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', 'location' => 'querystring', 'locationName' => 'assignment-status', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListIAMPolicyAssignmentsResponse' => [ 'type' => 'structure', 'members' => [ 'IAMPolicyAssignments' => [ 'shape' => 'IAMPolicyAssignmentSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIdentityPropagationConfigsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'MaxResults' => [ 'shape' => 'ListIdentityPropagationMaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListIdentityPropagationConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'Services' => [ 'shape' => 'AuthorizedTargetsByServices', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListIdentityPropagationMaxResults' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'ListIngestionsRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'MaxResults' => [ 'shape' => 'IngestionMaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListIngestionsResponse' => [ 'type' => 'structure', 'members' => [ 'Ingestions' => [ 'shape' => 'Ingestions', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListNamespacesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListNamespacesResponse' => [ 'type' => 'structure', 'members' => [ 'Namespaces' => [ 'shape' => 'Namespaces', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListRefreshSchedulesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'ListRefreshSchedulesResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshSchedules' => [ 'shape' => 'RefreshSchedules', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListRoleMembershipsRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListRoleMembershipsResponse' => [ 'type' => 'structure', 'members' => [ 'MembersList' => [ 'shape' => 'GroupsList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListTemplateAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListTemplateAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAliasList' => [ 'shape' => 'TemplateAliasList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListTemplateVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListTemplateVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateVersionSummaryList' => [ 'shape' => 'TemplateVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateSummaryList' => [ 'shape' => 'TemplateSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListThemeAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListThemeAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAliasList' => [ 'shape' => 'ThemeAliasList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListThemeVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListThemeVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeVersionSummaryList' => [ 'shape' => 'ThemeVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListThemesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Type' => [ 'shape' => 'ThemeType', 'location' => 'querystring', 'locationName' => 'type', ], ], ], 'ListThemesResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeSummaryList' => [ 'shape' => 'ThemeSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicRefreshSchedulesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'ListTopicRefreshSchedulesResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'RefreshSchedules' => [ 'shape' => 'TopicRefreshScheduleSummaries', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicReviewedAnswersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'ListTopicReviewedAnswersResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Answers' => [ 'shape' => 'TopicReviewedAnswers', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListTopicsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicsSummaries' => [ 'shape' => 'TopicSummaries', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListUserGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListUserGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'UserList' => [ 'shape' => 'UserList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListVPCConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVPCConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionSummaries' => [ 'shape' => 'VPCConnectionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'LoadingAnimation' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'LocalNavigationConfiguration' => [ 'type' => 'structure', 'required' => [ 'TargetSheetId', ], 'members' => [ 'TargetSheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'LogicalTable' => [ 'type' => 'structure', 'required' => [ 'Alias', 'Source', ], 'members' => [ 'Alias' => [ 'shape' => 'LogicalTableAlias', ], 'DataTransforms' => [ 'shape' => 'TransformOperationList', ], 'Source' => [ 'shape' => 'LogicalTableSource', ], ], ], 'LogicalTableAlias' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'LogicalTableId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9a-zA-Z-]*', ], 'LogicalTableMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogicalTableId', ], 'value' => [ 'shape' => 'LogicalTable', ], 'max' => 64, 'min' => 1, ], 'LogicalTableSource' => [ 'type' => 'structure', 'members' => [ 'JoinInstruction' => [ 'shape' => 'JoinInstruction', ], 'PhysicalTableId' => [ 'shape' => 'PhysicalTableId', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'Long' => [ 'type' => 'long', ], 'LongFormatText' => [ 'type' => 'structure', 'members' => [ 'PlainText' => [ 'shape' => 'LongPlainText', ], 'RichText' => [ 'shape' => 'LongRichText', ], ], ], 'LongPlainText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'LongRichText' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'Longitude' => [ 'type' => 'double', 'max' => 1800, 'min' => -1800, ], 'LookbackWindow' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'Size', 'SizeUnit', ], 'members' => [ 'ColumnName' => [ 'shape' => 'String', ], 'Size' => [ 'shape' => 'PositiveLong', ], 'SizeUnit' => [ 'shape' => 'LookbackWindowSizeUnit', ], ], ], 'LookbackWindowSizeUnit' => [ 'type' => 'string', 'enum' => [ 'HOUR', 'DAY', 'WEEK', ], ], 'ManifestFileLocation' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'S3Bucket', ], 'Key' => [ 'shape' => 'S3Key', ], ], ], 'MapZoomMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'MANUAL', ], ], 'MappedDataSetParameter' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'DataSetParameterName', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'DataSetParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'MappedDataSetParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'MappedDataSetParameter', ], 'max' => 150, 'min' => 0, ], 'MarginStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'MariaDbParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaximumLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'MaximumMinimumComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'Type' => [ 'shape' => 'MaximumMinimumComputationType', ], ], ], 'MaximumMinimumComputationType' => [ 'type' => 'string', 'enum' => [ 'MAXIMUM', 'MINIMUM', ], ], 'MeasureField' => [ 'type' => 'structure', 'members' => [ 'NumericalMeasureField' => [ 'shape' => 'NumericalMeasureField', ], 'CategoricalMeasureField' => [ 'shape' => 'CategoricalMeasureField', ], 'DateMeasureField' => [ 'shape' => 'DateMeasureField', ], 'CalculatedMeasureField' => [ 'shape' => 'CalculatedMeasureField', ], ], ], 'MeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 200, ], 'MemberIdArnPair' => [ 'type' => 'structure', 'members' => [ 'MemberId' => [ 'shape' => 'RestrictiveResourceId', ], 'MemberArn' => [ 'shape' => 'Arn', ], ], ], 'MemberType' => [ 'type' => 'string', 'enum' => [ 'DASHBOARD', 'ANALYSIS', 'DATASET', 'DATASOURCE', 'TOPIC', ], ], 'MetricComparisonComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'FromValue' => [ 'shape' => 'MeasureField', ], 'TargetValue' => [ 'shape' => 'MeasureField', ], ], ], 'MinimumLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'MissingDataConfiguration' => [ 'type' => 'structure', 'members' => [ 'TreatmentOption' => [ 'shape' => 'MissingDataTreatmentOption', ], ], ], 'MissingDataConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MissingDataConfiguration', ], 'max' => 100, ], 'MissingDataTreatmentOption' => [ 'type' => 'string', 'enum' => [ 'INTERPOLATE', 'SHOW_AS_ZERO', 'SHOW_AS_BLANK', ], ], 'MySqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'NamedEntityAggType' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MIN', 'MAX', 'COUNT', 'AVERAGE', 'DISTINCT_COUNT', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', 'MEDIAN', 'CUSTOM', ], ], 'NamedEntityDefinition' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], 'PropertyName' => [ 'shape' => 'LimitedString', ], 'PropertyRole' => [ 'shape' => 'PropertyRole', ], 'PropertyUsage' => [ 'shape' => 'PropertyUsage', ], 'Metric' => [ 'shape' => 'NamedEntityDefinitionMetric', ], ], ], 'NamedEntityDefinitionMetric' => [ 'type' => 'structure', 'members' => [ 'Aggregation' => [ 'shape' => 'NamedEntityAggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggregationFunctionParameters', ], ], ], 'NamedEntityDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'NamedEntityDefinition', ], ], 'NamedEntityRef' => [ 'type' => 'structure', 'members' => [ 'NamedEntityName' => [ 'shape' => 'LimitedString', ], ], ], 'NamedFilterAggType' => [ 'type' => 'string', 'enum' => [ 'NO_AGGREGATION', 'SUM', 'AVERAGE', 'COUNT', 'DISTINCT_COUNT', 'MAX', 'MEDIAN', 'MIN', 'STDEV', 'STDEVP', 'VAR', 'VARP', ], ], 'NamedFilterType' => [ 'type' => 'string', 'enum' => [ 'CATEGORY_FILTER', 'NUMERIC_EQUALITY_FILTER', 'NUMERIC_RANGE_FILTER', 'DATE_RANGE_FILTER', 'RELATIVE_DATE_FILTER', ], ], 'Namespace' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[a-zA-Z0-9._-]*$', ], 'NamespaceError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'NamespaceErrorType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'NamespaceErrorType' => [ 'type' => 'string', 'enum' => [ 'PERMISSION_DENIED', 'INTERNAL_SERVICE_ERROR', ], ], 'NamespaceInfoV2' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'Namespace', ], 'Arn' => [ 'shape' => 'Arn', ], 'CapacityRegion' => [ 'shape' => 'String', ], 'CreationStatus' => [ 'shape' => 'NamespaceStatus', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'NamespaceError' => [ 'shape' => 'NamespaceError', ], ], ], 'NamespaceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'CREATING', 'DELETING', 'RETRYABLE_FAILURE', 'NON_RETRYABLE_FAILURE', ], ], 'Namespaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NamespaceInfoV2', ], ], 'NarrativeString' => [ 'type' => 'string', 'max' => 150000, ], 'NegativeFormat' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'LimitedString', ], 'Suffix' => [ 'shape' => 'LimitedString', ], ], ], 'NegativeValueConfiguration' => [ 'type' => 'structure', 'required' => [ 'DisplayMode', ], 'members' => [ 'DisplayMode' => [ 'shape' => 'NegativeValueDisplayMode', ], ], ], 'NegativeValueDisplayMode' => [ 'type' => 'string', 'enum' => [ 'POSITIVE', 'NEGATIVE', ], ], 'NestedFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'IncludeInnerSet', 'InnerFilter', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeInnerSet' => [ 'shape' => 'Boolean', ], 'InnerFilter' => [ 'shape' => 'InnerFilter', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'SubnetId', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'NetworkInterfaceStatus', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^eni-[0-9a-z]*$', ], 'NetworkInterfaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkInterfaceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'AVAILABLE', 'CREATION_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETED', 'DELETION_FAILED', 'DELETION_SCHEDULED', 'ATTACHMENT_FAILED_ROLLBACK_FAILED', ], ], 'NewDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StringStaticValues' => [ 'shape' => 'StringDatasetParameterValueList', ], 'DecimalStaticValues' => [ 'shape' => 'DecimalDatasetParameterValueList', ], 'DateTimeStaticValues' => [ 'shape' => 'DateTimeDatasetParameterValueList', ], 'IntegerStaticValues' => [ 'shape' => 'IntegerDatasetParameterValueList', ], ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NonRepeatingVisualsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 20, ], 'NullFilterOption' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', 'NON_NULLS_ONLY', 'NULLS_ONLY', ], ], 'NullString' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'NullValueFormatConfiguration' => [ 'type' => 'structure', 'required' => [ 'NullString', ], 'members' => [ 'NullString' => [ 'shape' => 'NullString', ], ], ], 'NullableBoolean' => [ 'type' => 'boolean', ], 'NumberDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NumberScale' => [ 'shape' => 'NumberScale', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'NumberFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'FormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'NumberScale' => [ 'type' => 'string', 'enum' => [ 'NONE', 'AUTO', 'THOUSANDS', 'MILLIONS', 'BILLIONS', 'TRILLIONS', ], ], 'NumericAxisOptions' => [ 'type' => 'structure', 'members' => [ 'Scale' => [ 'shape' => 'AxisScale', ], 'Range' => [ 'shape' => 'AxisDisplayRange', ], ], ], 'NumericEqualityDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'Value', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'NumericEqualityFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'MatchOperator', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Double', 'box' => true, ], 'SelectAllOptions' => [ 'shape' => 'NumericFilterSelectAllOptions', ], 'MatchOperator' => [ 'shape' => 'NumericEqualityMatchOperator', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'NumericEqualityMatchOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'DOES_NOT_EQUAL', ], ], 'NumericFilterSelectAllOptions' => [ 'type' => 'string', 'enum' => [ 'FILTER_ALL_VALUES', ], ], 'NumericFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NumberDisplayFormatConfiguration' => [ 'shape' => 'NumberDisplayFormatConfiguration', ], 'CurrencyDisplayFormatConfiguration' => [ 'shape' => 'CurrencyDisplayFormatConfiguration', ], 'PercentageDisplayFormatConfiguration' => [ 'shape' => 'PercentageDisplayFormatConfiguration', ], ], ], 'NumericRangeFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeMinimum' => [ 'shape' => 'Boolean', 'box' => true, ], 'IncludeMaximum' => [ 'shape' => 'Boolean', 'box' => true, ], 'RangeMinimum' => [ 'shape' => 'NumericRangeFilterValue', 'box' => true, ], 'RangeMaximum' => [ 'shape' => 'NumericRangeFilterValue', 'box' => true, ], 'SelectAllOptions' => [ 'shape' => 'NumericFilterSelectAllOptions', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'NumericRangeFilterValue' => [ 'type' => 'structure', 'members' => [ 'StaticValue' => [ 'shape' => 'Double', 'box' => true, ], 'Parameter' => [ 'shape' => 'ParameterName', ], ], ], 'NumericSeparatorConfiguration' => [ 'type' => 'structure', 'members' => [ 'DecimalSeparator' => [ 'shape' => 'NumericSeparatorSymbol', ], 'ThousandsSeparator' => [ 'shape' => 'ThousandSeparatorOptions', ], ], ], 'NumericSeparatorSymbol' => [ 'type' => 'string', 'enum' => [ 'COMMA', 'DOT', 'SPACE', ], ], 'NumericalAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleNumericalAggregation' => [ 'shape' => 'SimpleNumericalAggregationFunction', ], 'PercentileAggregation' => [ 'shape' => 'PercentileAggregation', ], ], ], 'NumericalDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], ], ], 'NumericalMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'NumericalAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], ], ], 'OnClause' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'OperandList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], 'max' => 25, ], 'OptionalPort' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'OracleParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'OtherCategories' => [ 'type' => 'string', 'enum' => [ 'INCLUDE', 'EXCLUDE', ], ], 'OutputColumn' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ColumnName', ], 'Description' => [ 'shape' => 'ColumnDescriptiveText', ], 'Type' => [ 'shape' => 'ColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], ], ], 'OutputColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputColumn', ], ], 'OverrideDatasetParameterOperation' => [ 'type' => 'structure', 'required' => [ 'ParameterName', ], 'members' => [ 'ParameterName' => [ 'shape' => 'DatasetParameterName', ], 'NewParameterName' => [ 'shape' => 'DatasetParameterName', ], 'NewDefaultValues' => [ 'shape' => 'NewDefaultValues', ], ], ], 'PageNumber' => [ 'type' => 'long', 'min' => 0, ], 'PaginationConfiguration' => [ 'type' => 'structure', 'required' => [ 'PageSize', 'PageNumber', ], 'members' => [ 'PageSize' => [ 'shape' => 'Long', 'box' => true, ], 'PageNumber' => [ 'shape' => 'PageNumber', ], ], ], 'PanelBorderStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DASHED', 'DOTTED', ], ], 'PanelConfiguration' => [ 'type' => 'structure', 'members' => [ 'Title' => [ 'shape' => 'PanelTitleOptions', ], 'BorderVisibility' => [ 'shape' => 'Visibility', ], 'BorderThickness' => [ 'shape' => 'PixelLength', ], 'BorderStyle' => [ 'shape' => 'PanelBorderStyle', ], 'BorderColor' => [ 'shape' => 'HexColorWithTransparency', ], 'GutterVisibility' => [ 'shape' => 'Visibility', ], 'GutterSpacing' => [ 'shape' => 'PixelLength', ], 'BackgroundVisibility' => [ 'shape' => 'Visibility', ], 'BackgroundColor' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'PanelTitleOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'HorizontalTextAlignment' => [ 'shape' => 'HorizontalTextAlignment', ], ], ], 'PaperOrientation' => [ 'type' => 'string', 'enum' => [ 'PORTRAIT', 'LANDSCAPE', ], ], 'PaperSize' => [ 'type' => 'string', 'enum' => [ 'US_LETTER', 'US_LEGAL', 'US_TABLOID_LEDGER', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'JIS_B4', 'JIS_B5', ], ], 'ParameterControl' => [ 'type' => 'structure', 'members' => [ 'DateTimePicker' => [ 'shape' => 'ParameterDateTimePickerControl', ], 'List' => [ 'shape' => 'ParameterListControl', ], 'Dropdown' => [ 'shape' => 'ParameterDropDownControl', ], 'TextField' => [ 'shape' => 'ParameterTextFieldControl', ], 'TextArea' => [ 'shape' => 'ParameterTextAreaControl', ], 'Slider' => [ 'shape' => 'ParameterSliderControl', ], ], ], 'ParameterControlList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterControl', ], 'max' => 200, ], 'ParameterDateTimePickerControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], ], ], 'ParameterDeclaration' => [ 'type' => 'structure', 'members' => [ 'StringParameterDeclaration' => [ 'shape' => 'StringParameterDeclaration', ], 'DecimalParameterDeclaration' => [ 'shape' => 'DecimalParameterDeclaration', ], 'IntegerParameterDeclaration' => [ 'shape' => 'IntegerParameterDeclaration', ], 'DateTimeParameterDeclaration' => [ 'shape' => 'DateTimeParameterDeclaration', ], ], ], 'ParameterDeclarationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterDeclaration', ], 'max' => 200, ], 'ParameterDropDownControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'ParameterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'ParameterListControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'ParameterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'ParameterName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'ParameterSelectableValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 50000, ], 'ParameterSelectableValues' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'ParameterSelectableValueList', ], 'LinkToDataSetColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'ParameterSliderControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'ParameterTextAreaControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'ParameterTextFieldControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'ParameterValueType' => [ 'type' => 'string', 'enum' => [ 'MULTI_VALUED', 'SINGLE_VALUED', ], ], 'Parameters' => [ 'type' => 'structure', 'members' => [ 'StringParameters' => [ 'shape' => 'StringParameterList', ], 'IntegerParameters' => [ 'shape' => 'IntegerParameterList', ], 'DecimalParameters' => [ 'shape' => 'DecimalParameterList', ], 'DateTimeParameters' => [ 'shape' => 'DateTimeParameterList', ], ], ], 'Password' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'Path' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 10, 'min' => 1, ], 'PercentNumber' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'PercentVisibleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'PercentNumber', 'box' => true, ], 'To' => [ 'shape' => 'PercentNumber', 'box' => true, ], ], ], 'PercentageDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'PercentileAggregation' => [ 'type' => 'structure', 'members' => [ 'PercentileValue' => [ 'shape' => 'PercentileValue', ], ], ], 'PercentileValue' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'PeriodOverPeriodComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], ], ], 'PeriodToDateComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodTimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'PeriodsBackward' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'PeriodsForward' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'PhysicalTable' => [ 'type' => 'structure', 'members' => [ 'RelationalTable' => [ 'shape' => 'RelationalTable', ], 'CustomSql' => [ 'shape' => 'CustomSql', ], 'S3Source' => [ 'shape' => 'S3Source', ], ], ], 'PhysicalTableId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9a-zA-Z-]*', ], 'PhysicalTableMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PhysicalTableId', ], 'value' => [ 'shape' => 'PhysicalTable', ], 'max' => 32, 'min' => 0, ], 'PieChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'PieChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'PieChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'PieChartSortConfiguration', ], 'DonutOptions' => [ 'shape' => 'DonutOptions', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'PieChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'PieChartAggregatedFieldWells' => [ 'shape' => 'PieChartAggregatedFieldWells', ], ], ], 'PieChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'PieChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'PieChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'PivotFieldSortOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'SortBy', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'SortBy' => [ 'shape' => 'PivotTableSortBy', ], ], ], 'PivotFieldSortOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotFieldSortOptions', ], 'max' => 200, ], 'PivotMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 40, ], 'PivotTableAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Rows' => [ 'shape' => 'PivotTableDimensionList', ], 'Columns' => [ 'shape' => 'PivotTableDimensionList', ], 'Values' => [ 'shape' => 'PivotMeasureFieldList', ], ], ], 'PivotTableCellConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TextFormat' => [ 'shape' => 'TextConditionalFormat', ], 'Scope' => [ 'shape' => 'PivotTableConditionalFormattingScope', ], 'Scopes' => [ 'shape' => 'PivotTableConditionalFormattingScopeList', ], ], ], 'PivotTableConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'PivotTableConditionalFormattingOptionList', ], ], ], 'PivotTableConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'Cell' => [ 'shape' => 'PivotTableCellConditionalFormatting', ], ], ], 'PivotTableConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableConditionalFormattingOption', ], 'max' => 500, ], 'PivotTableConditionalFormattingScope' => [ 'type' => 'structure', 'members' => [ 'Role' => [ 'shape' => 'PivotTableConditionalFormattingScopeRole', ], ], ], 'PivotTableConditionalFormattingScopeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableConditionalFormattingScope', ], 'max' => 3, ], 'PivotTableConditionalFormattingScopeRole' => [ 'type' => 'string', 'enum' => [ 'FIELD', 'FIELD_TOTAL', 'GRAND_TOTAL', ], ], 'PivotTableConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'PivotTableFieldWells', ], 'SortConfiguration' => [ 'shape' => 'PivotTableSortConfiguration', ], 'TableOptions' => [ 'shape' => 'PivotTableOptions', ], 'TotalOptions' => [ 'shape' => 'PivotTableTotalOptions', ], 'FieldOptions' => [ 'shape' => 'PivotTableFieldOptions', ], 'PaginatedReportOptions' => [ 'shape' => 'PivotTablePaginatedReportOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'PivotTableDataPathOption' => [ 'type' => 'structure', 'required' => [ 'DataPathList', ], 'members' => [ 'DataPathList' => [ 'shape' => 'DataPathValueList', ], 'Width' => [ 'shape' => 'PixelLength', ], ], ], 'PivotTableDataPathOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableDataPathOption', ], 'max' => 100, ], 'PivotTableDataPathType' => [ 'type' => 'string', 'enum' => [ 'HIERARCHY_ROWS_LAYOUT_COLUMN', 'MULTIPLE_ROW_METRICS_COLUMN', 'EMPTY_COLUMN_HEADER', 'COUNT_METRIC_COLUMN', ], ], 'PivotTableDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 40, ], 'PivotTableFieldCollapseState' => [ 'type' => 'string', 'enum' => [ 'COLLAPSED', 'EXPANDED', ], ], 'PivotTableFieldCollapseStateOption' => [ 'type' => 'structure', 'required' => [ 'Target', ], 'members' => [ 'Target' => [ 'shape' => 'PivotTableFieldCollapseStateTarget', ], 'State' => [ 'shape' => 'PivotTableFieldCollapseState', ], ], ], 'PivotTableFieldCollapseStateOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldCollapseStateOption', ], ], 'PivotTableFieldCollapseStateTarget' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'String', ], 'FieldDataPathValues' => [ 'shape' => 'DataPathValueList', ], ], ], 'PivotTableFieldOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'CustomLabel' => [ 'shape' => 'CustomLabel', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'PivotTableFieldOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldOption', ], 'max' => 100, ], 'PivotTableFieldOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedFieldOptions' => [ 'shape' => 'PivotTableFieldOptionList', ], 'DataPathOptions' => [ 'shape' => 'PivotTableDataPathOptionList', ], 'CollapseStateOptions' => [ 'shape' => 'PivotTableFieldCollapseStateOptionList', ], ], ], 'PivotTableFieldSubtotalOptions' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], ], ], 'PivotTableFieldSubtotalOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldSubtotalOptions', ], 'max' => 100, ], 'PivotTableFieldWells' => [ 'type' => 'structure', 'members' => [ 'PivotTableAggregatedFieldWells' => [ 'shape' => 'PivotTableAggregatedFieldWells', ], ], ], 'PivotTableMetricPlacement' => [ 'type' => 'string', 'enum' => [ 'ROW', 'COLUMN', ], ], 'PivotTableOptions' => [ 'type' => 'structure', 'members' => [ 'MetricPlacement' => [ 'shape' => 'PivotTableMetricPlacement', ], 'SingleMetricVisibility' => [ 'shape' => 'Visibility', ], 'ColumnNamesVisibility' => [ 'shape' => 'Visibility', ], 'ToggleButtonsVisibility' => [ 'shape' => 'Visibility', ], 'ColumnHeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'RowHeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'CellStyle' => [ 'shape' => 'TableCellStyle', ], 'RowFieldNamesStyle' => [ 'shape' => 'TableCellStyle', ], 'RowAlternateColorOptions' => [ 'shape' => 'RowAlternateColorOptions', ], 'CollapsedRowDimensionsVisibility' => [ 'shape' => 'Visibility', ], 'RowsLayout' => [ 'shape' => 'PivotTableRowsLayout', ], 'RowsLabelOptions' => [ 'shape' => 'PivotTableRowsLabelOptions', ], 'DefaultCellWidth' => [ 'shape' => 'PixelLength', ], ], ], 'PivotTablePaginatedReportOptions' => [ 'type' => 'structure', 'members' => [ 'VerticalOverflowVisibility' => [ 'shape' => 'Visibility', ], 'OverflowColumnHeaderVisibility' => [ 'shape' => 'Visibility', ], ], ], 'PivotTableRowsLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CustomLabel' => [ 'shape' => 'PivotTableRowsLabelText', ], ], ], 'PivotTableRowsLabelText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'PivotTableRowsLayout' => [ 'type' => 'string', 'enum' => [ 'TABULAR', 'HIERARCHY', ], ], 'PivotTableSortBy' => [ 'type' => 'structure', 'members' => [ 'Field' => [ 'shape' => 'FieldSort', ], 'Column' => [ 'shape' => 'ColumnSort', ], 'DataPath' => [ 'shape' => 'DataPathSort', ], ], ], 'PivotTableSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldSortOptions' => [ 'shape' => 'PivotFieldSortOptionsList', ], ], ], 'PivotTableSubtotalLevel' => [ 'type' => 'string', 'enum' => [ 'ALL', 'CUSTOM', 'LAST', ], ], 'PivotTableTotalOptions' => [ 'type' => 'structure', 'members' => [ 'RowSubtotalOptions' => [ 'shape' => 'SubtotalOptions', ], 'ColumnSubtotalOptions' => [ 'shape' => 'SubtotalOptions', ], 'RowTotalOptions' => [ 'shape' => 'PivotTotalOptions', ], 'ColumnTotalOptions' => [ 'shape' => 'PivotTotalOptions', ], ], ], 'PivotTableVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'PivotTableConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'PivotTableConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'PivotTotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'Placement' => [ 'shape' => 'TableTotalsPlacement', ], 'ScrollStatus' => [ 'shape' => 'TableTotalsScrollStatus', ], 'CustomLabel' => [ 'shape' => 'String', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'ValueCellStyle' => [ 'shape' => 'TableCellStyle', ], 'MetricHeaderCellStyle' => [ 'shape' => 'TableCellStyle', ], 'TotalAggregationOptions' => [ 'shape' => 'TotalAggregationOptionList', ], ], ], 'PixelLength' => [ 'type' => 'string', ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 1, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'PostgreSqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'PreconditionNotMetException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'PredefinedHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', 'Columns', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'Columns' => [ 'shape' => 'PredefinedHierarchyColumnList', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'PredefinedHierarchyColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, 'min' => 1, ], 'PredictionInterval' => [ 'type' => 'integer', 'max' => 95, 'min' => 50, ], 'Prefix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'PrestoParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], ], ], 'PrimaryValueDisplayType' => [ 'type' => 'string', 'enum' => [ 'HIDDEN', 'COMPARISON', 'ACTUAL', ], ], 'Principal' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 100, 'min' => 1, ], 'ProgressBarOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ProjectId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ProjectOperation' => [ 'type' => 'structure', 'required' => [ 'ProjectedColumns', ], 'members' => [ 'ProjectedColumns' => [ 'shape' => 'ProjectedColumnList', ], ], ], 'ProjectedColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 2000, 'min' => 1, ], 'PropertyRole' => [ 'type' => 'string', 'enum' => [ 'PRIMARY', 'ID', ], ], 'PropertyUsage' => [ 'type' => 'string', 'enum' => [ 'INHERIT', 'DIMENSION', 'MEASURE', ], ], 'PurchaseMode' => [ 'type' => 'string', 'enum' => [ 'MANUAL', 'AUTO_PURCHASE', ], ], 'PutDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'DataSetRefreshProperties', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'DataSetRefreshProperties' => [ 'shape' => 'DataSetRefreshProperties', ], ], ], 'PutDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Query' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'QueryExecutionMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'MANUAL', ], ], 'QueryExecutionOptions' => [ 'type' => 'structure', 'members' => [ 'QueryExecutionMode' => [ 'shape' => 'QueryExecutionMode', ], ], ], 'QueueInfo' => [ 'type' => 'structure', 'required' => [ 'WaitingOnIngestion', 'QueuedIngestion', ], 'members' => [ 'WaitingOnIngestion' => [ 'shape' => 'String', ], 'QueuedIngestion' => [ 'shape' => 'String', ], ], ], 'QuickSightUserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RadarChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'RadarChartCategoryFieldList', ], 'Color' => [ 'shape' => 'RadarChartColorFieldList', ], 'Values' => [ 'shape' => 'RadarChartValuesFieldList', ], ], ], 'RadarChartAreaStyleSettings' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'RadarChartAxesRangeScale' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'INDEPENDENT', 'SHARED', ], ], 'RadarChartCategoryFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'RadarChartColorFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'RadarChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'RadarChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'RadarChartSortConfiguration', ], 'Shape' => [ 'shape' => 'RadarChartShape', ], 'BaseSeriesSettings' => [ 'shape' => 'RadarChartSeriesSettings', ], 'StartAngle' => [ 'shape' => 'RadarChartStartAngle', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'AlternateBandColorsVisibility' => [ 'shape' => 'Visibility', ], 'AlternateBandEvenColor' => [ 'shape' => 'HexColor', ], 'AlternateBandOddColor' => [ 'shape' => 'HexColor', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'AxesRangeScale' => [ 'shape' => 'RadarChartAxesRangeScale', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'RadarChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'RadarChartAggregatedFieldWells' => [ 'shape' => 'RadarChartAggregatedFieldWells', ], ], ], 'RadarChartSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'AreaStyleSettings' => [ 'shape' => 'RadarChartAreaStyleSettings', ], ], ], 'RadarChartShape' => [ 'type' => 'string', 'enum' => [ 'CIRCLE', 'POLYGON', ], ], 'RadarChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'RadarChartStartAngle' => [ 'type' => 'double', 'max' => 360, 'min' => -360, ], 'RadarChartValuesFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 20, ], 'RadarChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'RadarChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'RangeConstant' => [ 'type' => 'structure', 'members' => [ 'Minimum' => [ 'shape' => 'LimitedString', ], 'Maximum' => [ 'shape' => 'LimitedString', ], ], ], 'RangeEndsLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'RdsParameters' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Database', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'RecoveryWindowInDays' => [ 'type' => 'long', 'max' => 30, 'min' => 7, ], 'RedshiftIAMParameters' => [ 'type' => 'structure', 'required' => [ 'RoleArn', ], 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], 'DatabaseUser' => [ 'shape' => 'DatabaseUser', ], 'DatabaseGroups' => [ 'shape' => 'DatabaseGroupList', ], 'AutoCreateDatabaseUser' => [ 'shape' => 'Boolean', ], ], ], 'RedshiftParameters' => [ 'type' => 'structure', 'required' => [ 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'OptionalPort', ], 'Database' => [ 'shape' => 'Database', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'IAMParameters' => [ 'shape' => 'RedshiftIAMParameters', ], 'IdentityCenterConfiguration' => [ 'shape' => 'IdentityCenterConfiguration', ], ], ], 'ReferenceLine' => [ 'type' => 'structure', 'required' => [ 'DataConfiguration', ], 'members' => [ 'Status' => [ 'shape' => 'WidgetStatus', ], 'DataConfiguration' => [ 'shape' => 'ReferenceLineDataConfiguration', ], 'StyleConfiguration' => [ 'shape' => 'ReferenceLineStyleConfiguration', ], 'LabelConfiguration' => [ 'shape' => 'ReferenceLineLabelConfiguration', ], ], ], 'ReferenceLineCustomLabelConfiguration' => [ 'type' => 'structure', 'required' => [ 'CustomLabel', ], 'members' => [ 'CustomLabel' => [ 'shape' => 'NonEmptyString', ], ], ], 'ReferenceLineDataConfiguration' => [ 'type' => 'structure', 'members' => [ 'StaticConfiguration' => [ 'shape' => 'ReferenceLineStaticDataConfiguration', ], 'DynamicConfiguration' => [ 'shape' => 'ReferenceLineDynamicDataConfiguration', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'SeriesType' => [ 'shape' => 'ReferenceLineSeriesType', ], ], ], 'ReferenceLineDynamicDataConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', 'Calculation', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'MeasureAggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'Calculation' => [ 'shape' => 'NumericalAggregationFunction', ], ], ], 'ReferenceLineLabelConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueLabelConfiguration' => [ 'shape' => 'ReferenceLineValueLabelConfiguration', ], 'CustomLabelConfiguration' => [ 'shape' => 'ReferenceLineCustomLabelConfiguration', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'FontColor' => [ 'shape' => 'HexColor', ], 'HorizontalPosition' => [ 'shape' => 'ReferenceLineLabelHorizontalPosition', ], 'VerticalPosition' => [ 'shape' => 'ReferenceLineLabelVerticalPosition', ], ], ], 'ReferenceLineLabelHorizontalPosition' => [ 'type' => 'string', 'enum' => [ 'LEFT', 'CENTER', 'RIGHT', ], ], 'ReferenceLineLabelVerticalPosition' => [ 'type' => 'string', 'enum' => [ 'ABOVE', 'BELOW', ], ], 'ReferenceLineList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceLine', ], 'max' => 20, ], 'ReferenceLinePatternType' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DASHED', 'DOTTED', ], ], 'ReferenceLineSeriesType' => [ 'type' => 'string', 'enum' => [ 'BAR', 'LINE', ], ], 'ReferenceLineStaticDataConfiguration' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'Value' => [ 'shape' => 'SensitiveDouble', ], ], ], 'ReferenceLineStyleConfiguration' => [ 'type' => 'structure', 'members' => [ 'Pattern' => [ 'shape' => 'ReferenceLinePatternType', ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'ReferenceLineValueLabelConfiguration' => [ 'type' => 'structure', 'members' => [ 'RelativePosition' => [ 'shape' => 'ReferenceLineValueLabelRelativePosition', ], 'FormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'ReferenceLineValueLabelRelativePosition' => [ 'type' => 'string', 'enum' => [ 'BEFORE_CUSTOM_LABEL', 'AFTER_CUSTOM_LABEL', ], ], 'RefreshConfiguration' => [ 'type' => 'structure', 'required' => [ 'IncrementalRefresh', ], 'members' => [ 'IncrementalRefresh' => [ 'shape' => 'IncrementalRefresh', ], ], ], 'RefreshFrequency' => [ 'type' => 'structure', 'required' => [ 'Interval', ], 'members' => [ 'Interval' => [ 'shape' => 'RefreshInterval', ], 'RefreshOnDay' => [ 'shape' => 'ScheduleRefreshOnEntity', ], 'Timezone' => [ 'shape' => 'String', ], 'TimeOfTheDay' => [ 'shape' => 'String', ], ], ], 'RefreshInterval' => [ 'type' => 'string', 'enum' => [ 'MINUTE15', 'MINUTE30', 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'RefreshSchedule' => [ 'type' => 'structure', 'required' => [ 'ScheduleId', 'ScheduleFrequency', 'RefreshType', ], 'members' => [ 'ScheduleId' => [ 'shape' => 'String', ], 'ScheduleFrequency' => [ 'shape' => 'RefreshFrequency', ], 'StartAfterDateTime' => [ 'shape' => 'Timestamp', ], 'RefreshType' => [ 'shape' => 'IngestionType', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'RefreshSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'RefreshSchedule', ], ], 'RegisterUserRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityType', 'Email', 'UserRole', 'AwsAccountId', 'Namespace', ], 'members' => [ 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Email' => [ 'shape' => 'String', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'IamArn' => [ 'shape' => 'String', ], 'SessionName' => [ 'shape' => 'RoleSessionName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'UserName' => [ 'shape' => 'UserName', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'CustomFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'UserInvitationUrl' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'RegisteredCustomerManagedKey' => [ 'type' => 'structure', 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'DefaultKey' => [ 'shape' => 'Boolean', ], ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserDashboardFeatureConfigurations', ], ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], 'Bookmarks' => [ 'shape' => 'BookmarksConfigurations', ], ], ], 'RegisteredUserDashboardVisualEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardVisualId', ], 'members' => [ 'InitialDashboardVisualId' => [ 'shape' => 'DashboardVisualId', ], ], ], 'RegisteredUserEmbeddingExperienceConfiguration' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'RegisteredUserDashboardEmbeddingConfiguration', ], 'QuickSightConsole' => [ 'shape' => 'RegisteredUserQuickSightConsoleEmbeddingConfiguration', ], 'QSearchBar' => [ 'shape' => 'RegisteredUserQSearchBarEmbeddingConfiguration', ], 'DashboardVisual' => [ 'shape' => 'RegisteredUserDashboardVisualEmbeddingConfiguration', ], 'GenerativeQnA' => [ 'shape' => 'RegisteredUserGenerativeQnAEmbeddingConfiguration', ], ], ], 'RegisteredUserGenerativeQnAEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'RegisteredUserQSearchBarEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'RegisteredUserQuickSightConsoleEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialPath' => [ 'shape' => 'EntryPath', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserConsoleFeatureConfigurations', ], ], ], 'RelationalTable' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'Name', 'InputColumns', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'Catalog' => [ 'shape' => 'RelationalTableCatalog', ], 'Schema' => [ 'shape' => 'RelationalTableSchema', ], 'Name' => [ 'shape' => 'RelationalTableName', ], 'InputColumns' => [ 'shape' => 'InputColumnList', ], ], ], 'RelationalTableCatalog' => [ 'type' => 'string', 'max' => 256, ], 'RelationalTableName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RelationalTableSchema' => [ 'type' => 'string', 'max' => 256, ], 'RelativeDateTimeControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'RelativeDateType' => [ 'type' => 'string', 'enum' => [ 'PREVIOUS', 'THIS', 'LAST', 'NOW', 'NEXT', ], ], 'RelativeDatesFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'AnchorDateConfiguration', 'TimeGranularity', 'RelativeDateType', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AnchorDateConfiguration' => [ 'shape' => 'AnchorDateConfiguration', ], 'MinimumGranularity' => [ 'shape' => 'TimeGranularity', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'RelativeDateType' => [ 'shape' => 'RelativeDateType', ], 'RelativeDateValue' => [ 'shape' => 'Integer', 'box' => true, ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'ExcludePeriodConfiguration' => [ 'shape' => 'ExcludePeriodConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'RelativeFontSize' => [ 'type' => 'string', 'enum' => [ 'EXTRA_SMALL', 'SMALL', 'MEDIUM', 'LARGE', 'EXTRA_LARGE', ], ], 'RenameColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'NewColumnName', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'NewColumnName' => [ 'shape' => 'ColumnName', ], ], ], 'ResizeOption' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'RESPONSIVE', ], ], 'ResourceExistsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePermission' => [ 'type' => 'structure', 'required' => [ 'Principal', 'Actions', ], 'members' => [ 'Principal' => [ 'shape' => 'Principal', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'ResourcePermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 64, 'min' => 1, ], 'ResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'CREATION_SUCCESSFUL', 'CREATION_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_FAILED', 'DELETED', ], ], 'ResourceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, ], 'RestoreAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'RestoreAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'RestrictiveResourceId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ReviewedAnswerErrorCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'MISSING_ANSWER', 'DATASET_DOES_NOT_EXIST', 'INVALID_DATASET_ARN', 'DUPLICATED_ANSWER', 'INVALID_DATA', 'MISSING_REQUIRED_FIELDS', ], ], 'Role' => [ 'type' => 'string', 'enum' => [ 'ADMIN', 'AUTHOR', 'READER', 'ADMIN_PRO', 'AUTHOR_PRO', 'READER_PRO', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'RoleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9+=,.@_-]+$', ], 'RoleSessionName' => [ 'type' => 'string', 'max' => 64, 'min' => 2, 'pattern' => '[\\w+=.@-]*', ], 'RollingDateConfiguration' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Expression' => [ 'shape' => 'Expression', ], ], ], 'RowAlternateColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HexColor', ], 'max' => 1, ], 'RowAlternateColorOptions' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'WidgetStatus', ], 'RowAlternateColors' => [ 'shape' => 'RowAlternateColorList', ], 'UsePrimaryBackgroundColor' => [ 'shape' => 'WidgetStatus', ], ], ], 'RowInfo' => [ 'type' => 'structure', 'members' => [ 'RowsIngested' => [ 'shape' => 'Long', 'box' => true, ], 'RowsDropped' => [ 'shape' => 'Long', 'box' => true, ], 'TotalRowsInDataset' => [ 'shape' => 'Long', 'box' => true, ], ], ], 'RowLevelPermissionDataSet' => [ 'type' => 'structure', 'required' => [ 'Arn', 'PermissionPolicy', ], 'members' => [ 'Namespace' => [ 'shape' => 'Namespace', ], 'Arn' => [ 'shape' => 'Arn', ], 'PermissionPolicy' => [ 'shape' => 'RowLevelPermissionPolicy', ], 'FormatVersion' => [ 'shape' => 'RowLevelPermissionFormatVersion', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'RowLevelPermissionFormatVersion' => [ 'type' => 'string', 'enum' => [ 'VERSION_1', 'VERSION_2', ], ], 'RowLevelPermissionPolicy' => [ 'type' => 'string', 'enum' => [ 'GRANT_ACCESS', 'DENY_ACCESS', ], ], 'RowLevelPermissionTagConfiguration' => [ 'type' => 'structure', 'required' => [ 'TagRules', ], 'members' => [ 'Status' => [ 'shape' => 'Status', ], 'TagRules' => [ 'shape' => 'RowLevelPermissionTagRuleList', ], 'TagRuleConfigurations' => [ 'shape' => 'RowLevelPermissionTagRuleConfigurationList', ], ], ], 'RowLevelPermissionTagDelimiter' => [ 'type' => 'string', 'max' => 10, ], 'RowLevelPermissionTagRule' => [ 'type' => 'structure', 'required' => [ 'TagKey', 'ColumnName', ], 'members' => [ 'TagKey' => [ 'shape' => 'SessionTagKey', ], 'ColumnName' => [ 'shape' => 'String', ], 'TagMultiValueDelimiter' => [ 'shape' => 'RowLevelPermissionTagDelimiter', ], 'MatchAllValue' => [ 'shape' => 'SessionTagValue', ], ], ], 'RowLevelPermissionTagRuleConfiguration' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTagKey', ], 'max' => 50, 'min' => 1, ], 'RowLevelPermissionTagRuleConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RowLevelPermissionTagRuleConfiguration', ], 'max' => 50, 'min' => 1, ], 'RowLevelPermissionTagRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RowLevelPermissionTagRule', ], 'max' => 50, 'min' => 1, ], 'RowSortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldSortOptions', ], 'max' => 100, ], 'S3Bucket' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'S3BucketConfiguration' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'BucketPrefix', 'BucketRegion', ], 'members' => [ 'BucketName' => [ 'shape' => 'NonEmptyString', ], 'BucketPrefix' => [ 'shape' => 'NonEmptyString', ], 'BucketRegion' => [ 'shape' => 'NonEmptyString', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'S3Parameters' => [ 'type' => 'structure', 'required' => [ 'ManifestFileLocation', ], 'members' => [ 'ManifestFileLocation' => [ 'shape' => 'ManifestFileLocation', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Source' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'InputColumns', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'UploadSettings' => [ 'shape' => 'UploadSettings', ], 'InputColumns' => [ 'shape' => 'InputColumnList', ], ], ], 'S3Uri' => [ 'type' => 'string', 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SameSheetTargetVisualConfiguration' => [ 'type' => 'structure', 'members' => [ 'TargetVisuals' => [ 'shape' => 'TargetVisualList', ], 'TargetVisualOptions' => [ 'shape' => 'TargetVisualOptions', ], ], ], 'SankeyDiagramAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Source' => [ 'shape' => 'DimensionFieldList', ], 'Destination' => [ 'shape' => 'DimensionFieldList', ], 'Weight' => [ 'shape' => 'MeasureFieldList', ], ], ], 'SankeyDiagramChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'SankeyDiagramFieldWells', ], 'SortConfiguration' => [ 'shape' => 'SankeyDiagramSortConfiguration', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'SankeyDiagramFieldWells' => [ 'type' => 'structure', 'members' => [ 'SankeyDiagramAggregatedFieldWells' => [ 'shape' => 'SankeyDiagramAggregatedFieldWells', ], ], ], 'SankeyDiagramSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'WeightSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SourceItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'DestinationItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'SankeyDiagramVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'SankeyDiagramChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'XAxis' => [ 'shape' => 'MeasureFieldList', ], 'YAxis' => [ 'shape' => 'MeasureFieldList', ], 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Size' => [ 'shape' => 'MeasureFieldList', ], 'Label' => [ 'shape' => 'DimensionFieldList', ], ], ], 'ScatterPlotConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'ScatterPlotFieldWells', ], 'SortConfiguration' => [ 'shape' => 'ScatterPlotSortConfiguration', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'YAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'YAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'ScatterPlotFieldWells' => [ 'type' => 'structure', 'members' => [ 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'shape' => 'ScatterPlotCategoricallyAggregatedFieldWells', ], 'ScatterPlotUnaggregatedFieldWells' => [ 'shape' => 'ScatterPlotUnaggregatedFieldWells', ], ], ], 'ScatterPlotSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'ScatterPlotLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'ScatterPlotUnaggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'XAxis' => [ 'shape' => 'DimensionFieldList', ], 'YAxis' => [ 'shape' => 'DimensionFieldList', ], 'Size' => [ 'shape' => 'MeasureFieldList', ], 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Label' => [ 'shape' => 'DimensionFieldList', ], ], ], 'ScatterPlotVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'ScatterPlotConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'ScheduleRefreshOnEntity' => [ 'type' => 'structure', 'members' => [ 'DayOfWeek' => [ 'shape' => 'DayOfWeek', ], 'DayOfMonth' => [ 'shape' => 'DayOfMonth', ], ], ], 'ScrollBarOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'VisibleRange' => [ 'shape' => 'VisibleRangeOptions', ], ], ], 'SearchAnalysesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'AnalysisSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchAnalysesResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisSummaryList' => [ 'shape' => 'AnalysisSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDashboardsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DashboardSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDashboardsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardSummaryList' => [ 'shape' => 'DashboardSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDataSetsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DataSetSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDataSetsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetSummaries' => [ 'shape' => 'DataSetSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DataSourceSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceSummaries' => [ 'shape' => 'DataSourceSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchFoldersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'FolderSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchFoldersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderSummaryList' => [ 'shape' => 'FolderSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Filters' => [ 'shape' => 'GroupSearchFilterList', ], ], ], 'SearchGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Seasonality' => [ 'type' => 'integer', 'max' => 180, 'min' => 1, ], 'SecondaryValueOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+', ], 'SectionAfterPageBreak' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SectionPageBreakStatus', ], ], ], 'SectionBasedLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'PaperCanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutPaperCanvasSizeOptions', ], ], ], 'SectionBasedLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'HeaderSections', 'BodySections', 'FooterSections', 'CanvasSizeOptions', ], 'members' => [ 'HeaderSections' => [ 'shape' => 'HeaderFooterSectionConfigurationList', ], 'BodySections' => [ 'shape' => 'BodySectionConfigurationList', ], 'FooterSections' => [ 'shape' => 'HeaderFooterSectionConfigurationList', ], 'CanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutCanvasSizeOptions', ], ], ], 'SectionBasedLayoutPaperCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'PaperSize' => [ 'shape' => 'PaperSize', ], 'PaperOrientation' => [ 'shape' => 'PaperOrientation', ], 'PaperMargin' => [ 'shape' => 'Spacing', ], ], ], 'SectionLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'FreeFormLayout', ], 'members' => [ 'FreeFormLayout' => [ 'shape' => 'FreeFormSectionLayoutConfiguration', ], ], ], 'SectionPageBreakConfiguration' => [ 'type' => 'structure', 'members' => [ 'After' => [ 'shape' => 'SectionAfterPageBreak', ], ], ], 'SectionPageBreakStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SectionStyle' => [ 'type' => 'structure', 'members' => [ 'Height' => [ 'shape' => 'PixelLength', ], 'Padding' => [ 'shape' => 'Spacing', ], ], ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^sg-[0-9a-z]*$', ], 'SecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 16, 'min' => 1, ], 'SelectAllValueOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', ], ], 'SelectedFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 20, 'min' => 1, ], 'SelectedFieldOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_FIELDS', ], ], 'SelectedSheetsFilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [ 'SheetVisualScopingConfigurations' => [ 'shape' => 'SheetVisualScopingConfigurations', ], ], ], 'SelectedTooltipType' => [ 'type' => 'string', 'enum' => [ 'BASIC', 'DETAILED', ], ], 'SemanticEntityType' => [ 'type' => 'structure', 'members' => [ 'TypeName' => [ 'shape' => 'LimitedString', ], 'SubTypeName' => [ 'shape' => 'LimitedString', ], 'TypeParameters' => [ 'shape' => 'TypeParameters', ], ], ], 'SemanticType' => [ 'type' => 'structure', 'members' => [ 'TypeName' => [ 'shape' => 'LimitedString', ], 'SubTypeName' => [ 'shape' => 'LimitedString', ], 'TypeParameters' => [ 'shape' => 'TypeParameters', ], 'TruthyCellValue' => [ 'shape' => 'SensitiveString', ], 'TruthyCellValueSynonyms' => [ 'shape' => 'SensitiveStringList', ], 'FalseyCellValue' => [ 'shape' => 'SensitiveString', ], 'FalseyCellValueSynonyms' => [ 'shape' => 'SensitiveStringList', ], ], ], 'SensitiveDouble' => [ 'type' => 'double', 'sensitive' => true, ], 'SensitiveDoubleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveDouble', ], ], 'SensitiveDoubleObject' => [ 'type' => 'double', 'sensitive' => true, ], 'SensitiveLong' => [ 'type' => 'long', 'sensitive' => true, ], 'SensitiveLongList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveLong', ], ], 'SensitiveLongObject' => [ 'type' => 'long', 'sensitive' => true, ], 'SensitiveS3Uri' => [ 'type' => 'string', 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveString', ], ], 'SensitiveStringObject' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveTimestamp' => [ 'type' => 'timestamp', 'sensitive' => true, ], 'SensitiveTimestampList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveTimestamp', ], ], 'SeriesItem' => [ 'type' => 'structure', 'members' => [ 'FieldSeriesItem' => [ 'shape' => 'FieldSeriesItem', ], 'DataFieldSeriesItem' => [ 'shape' => 'DataFieldSeriesItem', ], ], ], 'SeriesItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SeriesItem', ], 'max' => 2000, ], 'ServiceNowParameters' => [ 'type' => 'structure', 'required' => [ 'SiteBaseUrl', ], 'members' => [ 'SiteBaseUrl' => [ 'shape' => 'SiteBaseUrl', ], ], ], 'ServiceType' => [ 'type' => 'string', 'enum' => [ 'REDSHIFT', ], ], 'SessionLifetimeInMinutes' => [ 'type' => 'long', 'max' => 600, 'min' => 15, ], 'SessionLifetimeInMinutesInvalidException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'SessionTag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'SessionTagKey', ], 'Value' => [ 'shape' => 'SessionTagValue', ], ], ], 'SessionTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SessionTagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTagKey', ], 'max' => 50, 'min' => 1, ], 'SessionTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTag', ], 'max' => 50, 'min' => 1, ], 'SessionTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'sensitive' => true, ], 'SetParameterValueConfiguration' => [ 'type' => 'structure', 'required' => [ 'DestinationParameterName', 'Value', ], 'members' => [ 'DestinationParameterName' => [ 'shape' => 'ParameterName', ], 'Value' => [ 'shape' => 'DestinationParameterValueConfiguration', ], ], ], 'SetParameterValueConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SetParameterValueConfiguration', ], 'max' => 200, 'min' => 1, ], 'ShapeConditionalFormat' => [ 'type' => 'structure', 'required' => [ 'BackgroundColor', ], 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'SharedViewConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'SharingModel' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'NAMESPACE', ], ], 'Sheet' => [ 'type' => 'structure', 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'SheetName', ], ], ], 'SheetContentType' => [ 'type' => 'string', 'enum' => [ 'PAGINATED', 'INTERACTIVE', ], ], 'SheetControlDateTimePickerType' => [ 'type' => 'string', 'enum' => [ 'SINGLE_VALUED', 'DATE_RANGE', ], ], 'SheetControlInfoIconLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'InfoIconText' => [ 'shape' => 'SheetControlInfoIconText', ], ], ], 'SheetControlInfoIconText' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SheetControlLayout' => [ 'type' => 'structure', 'required' => [ 'Configuration', ], 'members' => [ 'Configuration' => [ 'shape' => 'SheetControlLayoutConfiguration', ], ], ], 'SheetControlLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'GridLayout' => [ 'shape' => 'GridLayoutConfiguration', ], ], ], 'SheetControlLayoutList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetControlLayout', ], 'max' => 1, 'min' => 0, ], 'SheetControlListType' => [ 'type' => 'string', 'enum' => [ 'MULTI_SELECT', 'SINGLE_SELECT', ], ], 'SheetControlSliderType' => [ 'type' => 'string', 'enum' => [ 'SINGLE_POINT', 'RANGE', ], ], 'SheetControlTitle' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'SheetControlsOption' => [ 'type' => 'structure', 'members' => [ 'VisibilityState' => [ 'shape' => 'DashboardUIState', ], ], ], 'SheetDefinition' => [ 'type' => 'structure', 'required' => [ 'SheetId', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetTitle', ], 'Description' => [ 'shape' => 'SheetDescription', ], 'Name' => [ 'shape' => 'SheetName', ], 'ParameterControls' => [ 'shape' => 'ParameterControlList', ], 'FilterControls' => [ 'shape' => 'FilterControlList', ], 'Visuals' => [ 'shape' => 'VisualList', ], 'TextBoxes' => [ 'shape' => 'SheetTextBoxList', ], 'Layouts' => [ 'shape' => 'LayoutList', ], 'SheetControlLayouts' => [ 'shape' => 'SheetControlLayoutList', ], 'ContentType' => [ 'shape' => 'SheetContentType', ], ], ], 'SheetDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetDefinition', ], 'max' => 20, ], 'SheetDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SheetElementConfigurationOverrides' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'SheetElementRenderingRule' => [ 'type' => 'structure', 'required' => [ 'Expression', 'ConfigurationOverrides', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'ConfigurationOverrides' => [ 'shape' => 'SheetElementConfigurationOverrides', ], ], ], 'SheetElementRenderingRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetElementRenderingRule', ], 'max' => 10000, ], 'SheetLayoutElementMaximizationOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'SheetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Sheet', ], 'max' => 20, ], 'SheetName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'SheetStyle' => [ 'type' => 'structure', 'members' => [ 'Tile' => [ 'shape' => 'TileStyle', ], 'TileLayout' => [ 'shape' => 'TileLayoutStyle', ], ], ], 'SheetTextBox' => [ 'type' => 'structure', 'required' => [ 'SheetTextBoxId', ], 'members' => [ 'SheetTextBoxId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Content' => [ 'shape' => 'SheetTextBoxContent', ], ], ], 'SheetTextBoxContent' => [ 'type' => 'string', 'max' => 150000, ], 'SheetTextBoxList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetTextBox', ], 'max' => 100, ], 'SheetTitle' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SheetVisualScopingConfiguration' => [ 'type' => 'structure', 'required' => [ 'SheetId', 'Scope', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Scope' => [ 'shape' => 'FilterVisualScope', ], 'VisualIds' => [ 'shape' => 'FilteredVisualsList', ], ], ], 'SheetVisualScopingConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetVisualScopingConfiguration', ], 'max' => 50, 'min' => 1, ], 'ShortFormatText' => [ 'type' => 'structure', 'members' => [ 'PlainText' => [ 'shape' => 'ShortPlainText', ], 'RichText' => [ 'shape' => 'ShortRichText', ], ], ], 'ShortPlainText' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ShortRestrictiveResourceId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ShortRichText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SignupResponse' => [ 'type' => 'structure', 'members' => [ 'IAMUser' => [ 'shape' => 'Boolean', ], 'userLoginName' => [ 'shape' => 'String', ], 'accountName' => [ 'shape' => 'String', ], 'directoryType' => [ 'shape' => 'String', ], ], ], 'SimpleAttributeAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'UNIQUE_VALUE', ], ], 'SimpleClusterMarker' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], ], ], 'SimpleNumericalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'SUM', 'AVERAGE', 'MIN', 'MAX', 'COUNT', 'DISTINCT_COUNT', 'VAR', 'VARP', 'STDEV', 'STDEVP', 'MEDIAN', ], ], 'SimpleTotalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'SUM', 'AVERAGE', 'MIN', 'MAX', 'NONE', ], ], 'SingleAxisOptions' => [ 'type' => 'structure', 'members' => [ 'YAxisOptions' => [ 'shape' => 'YAxisOptions', ], ], ], 'SingleYAxisOption' => [ 'type' => 'string', 'enum' => [ 'PRIMARY_Y_AXIS', ], ], 'SiteBaseUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SliderControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'Slot' => [ 'type' => 'structure', 'members' => [ 'SlotId' => [ 'shape' => 'LimitedString', ], 'VisualId' => [ 'shape' => 'LimitedString', ], ], ], 'Slots' => [ 'type' => 'list', 'member' => [ 'shape' => 'Slot', ], ], 'SmallMultiplesAxisPlacement' => [ 'type' => 'string', 'enum' => [ 'OUTSIDE', 'INSIDE', ], ], 'SmallMultiplesAxisProperties' => [ 'type' => 'structure', 'members' => [ 'Scale' => [ 'shape' => 'SmallMultiplesAxisScale', ], 'Placement' => [ 'shape' => 'SmallMultiplesAxisPlacement', ], ], ], 'SmallMultiplesAxisScale' => [ 'type' => 'string', 'enum' => [ 'SHARED', 'INDEPENDENT', ], ], 'SmallMultiplesDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'SmallMultiplesOptions' => [ 'type' => 'structure', 'members' => [ 'MaxVisibleRows' => [ 'shape' => 'VisiblePanelRows', ], 'MaxVisibleColumns' => [ 'shape' => 'VisiblePanelColumns', ], 'PanelConfiguration' => [ 'shape' => 'PanelConfiguration', ], 'XAxis' => [ 'shape' => 'SmallMultiplesAxisProperties', ], 'YAxis' => [ 'shape' => 'SmallMultiplesAxisProperties', ], ], ], 'SnapshotAnonymousUser' => [ 'type' => 'structure', 'members' => [ 'RowLevelPermissionTags' => [ 'shape' => 'SessionTagList', ], ], ], 'SnapshotAnonymousUserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotAnonymousUser', ], 'max' => 1, 'min' => 1, ], 'SnapshotAnonymousUserRedacted' => [ 'type' => 'structure', 'members' => [ 'RowLevelPermissionTagKeys' => [ 'shape' => 'SessionTagKeyList', ], ], ], 'SnapshotAnonymousUserRedactedList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotAnonymousUserRedacted', ], 'max' => 1, 'min' => 1, ], 'SnapshotConfiguration' => [ 'type' => 'structure', 'required' => [ 'FileGroups', ], 'members' => [ 'FileGroups' => [ 'shape' => 'SnapshotFileGroupList', ], 'DestinationConfiguration' => [ 'shape' => 'SnapshotDestinationConfiguration', ], 'Parameters' => [ 'shape' => 'Parameters', ], ], ], 'SnapshotDestinationConfiguration' => [ 'type' => 'structure', 'members' => [ 'S3Destinations' => [ 'shape' => 'SnapshotS3DestinationConfigurationList', ], ], ], 'SnapshotFile' => [ 'type' => 'structure', 'required' => [ 'SheetSelections', 'FormatType', ], 'members' => [ 'SheetSelections' => [ 'shape' => 'SnapshotFileSheetSelectionList', ], 'FormatType' => [ 'shape' => 'SnapshotFileFormatType', ], ], ], 'SnapshotFileFormatType' => [ 'type' => 'string', 'enum' => [ 'CSV', 'PDF', 'EXCEL', ], ], 'SnapshotFileGroup' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'SnapshotFileList', ], ], ], 'SnapshotFileGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFileGroup', ], 'max' => 7, 'min' => 1, ], 'SnapshotFileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFile', ], 'max' => 1, 'min' => 1, ], 'SnapshotFileSheetSelection' => [ 'type' => 'structure', 'required' => [ 'SheetId', 'SelectionScope', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SelectionScope' => [ 'shape' => 'SnapshotFileSheetSelectionScope', ], 'VisualIds' => [ 'shape' => 'SnapshotFileSheetSelectionVisualIdList', ], ], ], 'SnapshotFileSheetSelectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFileSheetSelection', ], 'max' => 5, 'min' => 1, ], 'SnapshotFileSheetSelectionScope' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', 'SELECTED_VISUALS', ], ], 'SnapshotFileSheetSelectionVisualIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 5, 'min' => 1, ], 'SnapshotJobErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], ], ], 'SnapshotJobResult' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'AnonymousUserSnapshotJobResultList', ], ], ], 'SnapshotJobResultErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], ], ], 'SnapshotJobResultErrorInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobResultErrorInfo', ], ], 'SnapshotJobResultFileGroup' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'SnapshotFileList', ], 'S3Results' => [ 'shape' => 'SnapshotJobS3ResultList', ], ], ], 'SnapshotJobResultFileGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobResultFileGroup', ], ], 'SnapshotJobS3Result' => [ 'type' => 'structure', 'members' => [ 'S3DestinationConfiguration' => [ 'shape' => 'SnapshotS3DestinationConfiguration', ], 'S3Uri' => [ 'shape' => 'SensitiveS3Uri', ], 'ErrorInfo' => [ 'shape' => 'SnapshotJobResultErrorInfoList', ], ], ], 'SnapshotJobS3ResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobS3Result', ], ], 'SnapshotJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED', 'RUNNING', 'COMPLETED', 'FAILED', ], ], 'SnapshotS3DestinationConfiguration' => [ 'type' => 'structure', 'required' => [ 'BucketConfiguration', ], 'members' => [ 'BucketConfiguration' => [ 'shape' => 'S3BucketConfiguration', ], ], ], 'SnapshotS3DestinationConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotS3DestinationConfiguration', ], 'max' => 1, 'min' => 1, ], 'SnapshotUserConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'SnapshotAnonymousUserList', ], ], ], 'SnapshotUserConfigurationRedacted' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'SnapshotAnonymousUserRedactedList', ], ], ], 'SnowflakeParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Database', 'Warehouse', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Database' => [ 'shape' => 'Database', ], 'Warehouse' => [ 'shape' => 'Warehouse', ], ], ], 'SortDirection' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'Spacing' => [ 'type' => 'structure', 'members' => [ 'Top' => [ 'shape' => 'Length', ], 'Bottom' => [ 'shape' => 'Length', ], 'Left' => [ 'shape' => 'Length', ], 'Right' => [ 'shape' => 'Length', ], ], ], 'SparkParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], ], ], 'SpecialValue' => [ 'type' => 'string', 'enum' => [ 'EMPTY', 'NULL', 'OTHER', ], ], 'SqlEndpointPath' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'SqlQuery' => [ 'type' => 'string', 'max' => 168000, 'min' => 1, ], 'SqlServerParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'SslProperties' => [ 'type' => 'structure', 'members' => [ 'DisableSsl' => [ 'shape' => 'Boolean', ], ], ], 'StarburstParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'ProductType' => [ 'shape' => 'StarburstProductType', ], ], ], 'StarburstProductType' => [ 'type' => 'string', 'enum' => [ 'GALAXY', 'ENTERPRISE', ], ], 'StartAssetBundleExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleExportJobId', 'ResourceArns', 'ExportFormat', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ResourceArns' => [ 'shape' => 'AssetBundleResourceArns', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'CloudFormationOverridePropertyConfiguration' => [ 'shape' => 'AssetBundleCloudFormationOverridePropertyConfiguration', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], 'ValidationStrategy' => [ 'shape' => 'AssetBundleExportJobValidationStrategy', ], ], ], 'StartAssetBundleExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StartAssetBundleImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleImportJobId', 'AssetBundleImportSource', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AssetBundleImportSource' => [ 'shape' => 'AssetBundleImportSource', ], 'OverrideParameters' => [ 'shape' => 'AssetBundleImportJobOverrideParameters', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], 'OverridePermissions' => [ 'shape' => 'AssetBundleImportJobOverridePermissions', ], 'OverrideTags' => [ 'shape' => 'AssetBundleImportJobOverrideTags', ], 'OverrideValidationStrategy' => [ 'shape' => 'AssetBundleImportJobOverrideValidationStrategy', ], ], ], 'StartAssetBundleImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StartDashboardSnapshotJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', 'UserConfiguration', 'SnapshotConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UserConfiguration' => [ 'shape' => 'SnapshotUserConfiguration', ], 'SnapshotConfiguration' => [ 'shape' => 'SnapshotConfiguration', ], ], ], 'StartDashboardSnapshotJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StatePersistenceConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'StatusCode' => [ 'type' => 'integer', ], 'String' => [ 'type' => 'string', ], 'StringDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'StringDatasetParameterDefaultValues', ], ], ], 'StringDatasetParameterDefaultValue' => [ 'type' => 'string', 'max' => 512, 'min' => 0, ], 'StringDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'StringDatasetParameterValueList', ], ], ], 'StringDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'StringDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveStringObject', ], 'max' => 50000, ], 'StringDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'StringDefaultValueList', ], ], ], 'StringFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], 'NumericFormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveStringList', ], ], ], 'StringParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'StringDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'StringValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'StringParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameter', ], 'max' => 100, ], 'StringValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveString', ], ], ], 'StyledCellType' => [ 'type' => 'string', 'enum' => [ 'TOTAL', 'METRIC_HEADER', 'VALUE', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^subnet-[0-9a-z]*$', ], 'SubnetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 15, 'min' => 2, ], 'SubtotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'CustomLabel' => [ 'shape' => 'String', ], 'FieldLevel' => [ 'shape' => 'PivotTableSubtotalLevel', ], 'FieldLevelOptions' => [ 'shape' => 'PivotTableFieldSubtotalOptionsList', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'ValueCellStyle' => [ 'shape' => 'TableCellStyle', ], 'MetricHeaderCellStyle' => [ 'shape' => 'TableCellStyle', ], 'StyleTargets' => [ 'shape' => 'TableStyleTargetList', ], ], ], 'SucceededTopicReviewedAnswer' => [ 'type' => 'structure', 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], ], ], 'SucceededTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'SucceededTopicReviewedAnswer', ], ], 'SuccessfulKeyRegistrationEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessfulKeyRegistrationEntry', ], ], 'SuccessfulKeyRegistrationEntry' => [ 'type' => 'structure', 'required' => [ 'KeyArn', 'StatusCode', ], 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'StatusCode' => [ 'shape' => 'StatusCode', ], ], ], 'Suffix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'Synonyms' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitedString', ], ], 'TableAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], ], ], 'TableBorderOptions' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], 'Thickness' => [ 'shape' => 'TableBorderThickness', ], 'Style' => [ 'shape' => 'TableBorderStyle', ], ], ], 'TableBorderStyle' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SOLID', ], ], 'TableBorderThickness' => [ 'type' => 'integer', 'max' => 4, 'min' => 1, ], 'TableCellConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TextFormat' => [ 'shape' => 'TextConditionalFormat', ], ], ], 'TableCellImageScalingConfiguration' => [ 'type' => 'string', 'enum' => [ 'FIT_TO_CELL_HEIGHT', 'FIT_TO_CELL_WIDTH', 'DO_NOT_SCALE', ], ], 'TableCellImageSizingConfiguration' => [ 'type' => 'structure', 'members' => [ 'TableCellImageScalingConfiguration' => [ 'shape' => 'TableCellImageScalingConfiguration', ], ], ], 'TableCellStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'TextWrap' => [ 'shape' => 'TextWrap', ], 'HorizontalTextAlignment' => [ 'shape' => 'HorizontalTextAlignment', ], 'VerticalTextAlignment' => [ 'shape' => 'VerticalTextAlignment', ], 'BackgroundColor' => [ 'shape' => 'HexColor', ], 'Height' => [ 'shape' => 'TableFieldHeight', ], 'Border' => [ 'shape' => 'GlobalTableBorderOptions', ], ], ], 'TableConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'TableConditionalFormattingOptionList', ], ], ], 'TableConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'Cell' => [ 'shape' => 'TableCellConditionalFormatting', ], 'Row' => [ 'shape' => 'TableRowConditionalFormatting', ], ], ], 'TableConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableConditionalFormattingOption', ], 'max' => 500, ], 'TableConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'TableFieldWells', ], 'SortConfiguration' => [ 'shape' => 'TableSortConfiguration', ], 'TableOptions' => [ 'shape' => 'TableOptions', ], 'TotalOptions' => [ 'shape' => 'TotalOptions', ], 'FieldOptions' => [ 'shape' => 'TableFieldOptions', ], 'PaginatedReportOptions' => [ 'shape' => 'TablePaginatedReportOptions', ], 'TableInlineVisualizations' => [ 'shape' => 'TableInlineVisualizationList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'TableFieldCustomIconContent' => [ 'type' => 'structure', 'members' => [ 'Icon' => [ 'shape' => 'TableFieldIconSetType', ], ], ], 'TableFieldCustomTextContent' => [ 'type' => 'structure', 'required' => [ 'FontConfiguration', ], 'members' => [ 'Value' => [ 'shape' => 'String', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], ], ], 'TableFieldHeight' => [ 'type' => 'integer', 'max' => 500, 'min' => 8, ], 'TableFieldIconSetType' => [ 'type' => 'string', 'enum' => [ 'LINK', ], ], 'TableFieldImageConfiguration' => [ 'type' => 'structure', 'members' => [ 'SizingOptions' => [ 'shape' => 'TableCellImageSizingConfiguration', ], ], ], 'TableFieldLinkConfiguration' => [ 'type' => 'structure', 'required' => [ 'Target', 'Content', ], 'members' => [ 'Target' => [ 'shape' => 'URLTargetConfiguration', ], 'Content' => [ 'shape' => 'TableFieldLinkContentConfiguration', ], ], ], 'TableFieldLinkContentConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomTextContent' => [ 'shape' => 'TableFieldCustomTextContent', ], 'CustomIconContent' => [ 'shape' => 'TableFieldCustomIconContent', ], ], ], 'TableFieldOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Width' => [ 'shape' => 'PixelLength', ], 'CustomLabel' => [ 'shape' => 'CustomLabel', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'URLStyling' => [ 'shape' => 'TableFieldURLConfiguration', ], ], ], 'TableFieldOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableFieldOption', ], 'max' => 100, ], 'TableFieldOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedFieldOptions' => [ 'shape' => 'TableFieldOptionList', ], 'Order' => [ 'shape' => 'FieldOrderList', ], 'PinnedFieldOptions' => [ 'shape' => 'TablePinnedFieldOptions', ], ], ], 'TableFieldOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 201, ], 'TableFieldURLConfiguration' => [ 'type' => 'structure', 'members' => [ 'LinkConfiguration' => [ 'shape' => 'TableFieldLinkConfiguration', ], 'ImageConfiguration' => [ 'shape' => 'TableFieldImageConfiguration', ], ], ], 'TableFieldWells' => [ 'type' => 'structure', 'members' => [ 'TableAggregatedFieldWells' => [ 'shape' => 'TableAggregatedFieldWells', ], 'TableUnaggregatedFieldWells' => [ 'shape' => 'TableUnaggregatedFieldWells', ], ], ], 'TableInlineVisualization' => [ 'type' => 'structure', 'members' => [ 'DataBars' => [ 'shape' => 'DataBarsOptions', ], ], ], 'TableInlineVisualizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableInlineVisualization', ], 'max' => 200, ], 'TableOptions' => [ 'type' => 'structure', 'members' => [ 'Orientation' => [ 'shape' => 'TableOrientation', ], 'HeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'CellStyle' => [ 'shape' => 'TableCellStyle', ], 'RowAlternateColorOptions' => [ 'shape' => 'RowAlternateColorOptions', ], ], ], 'TableOrientation' => [ 'type' => 'string', 'enum' => [ 'VERTICAL', 'HORIZONTAL', ], ], 'TablePaginatedReportOptions' => [ 'type' => 'structure', 'members' => [ 'VerticalOverflowVisibility' => [ 'shape' => 'Visibility', ], 'OverflowColumnHeaderVisibility' => [ 'shape' => 'Visibility', ], ], ], 'TablePinnedFieldOptions' => [ 'type' => 'structure', 'members' => [ 'PinnedLeftFields' => [ 'shape' => 'TableFieldOrderList', ], ], ], 'TableRowConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'TableSideBorderOptions' => [ 'type' => 'structure', 'members' => [ 'InnerVertical' => [ 'shape' => 'TableBorderOptions', ], 'InnerHorizontal' => [ 'shape' => 'TableBorderOptions', ], 'Left' => [ 'shape' => 'TableBorderOptions', ], 'Right' => [ 'shape' => 'TableBorderOptions', ], 'Top' => [ 'shape' => 'TableBorderOptions', ], 'Bottom' => [ 'shape' => 'TableBorderOptions', ], ], ], 'TableSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'RowSort' => [ 'shape' => 'RowSortList', ], 'PaginationConfiguration' => [ 'shape' => 'PaginationConfiguration', ], ], ], 'TableStyleTarget' => [ 'type' => 'structure', 'required' => [ 'CellType', ], 'members' => [ 'CellType' => [ 'shape' => 'StyledCellType', ], ], ], 'TableStyleTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableStyleTarget', ], 'max' => 3, ], 'TableTotalsPlacement' => [ 'type' => 'string', 'enum' => [ 'START', 'END', 'AUTO', ], ], 'TableTotalsScrollStatus' => [ 'type' => 'string', 'enum' => [ 'PINNED', 'SCROLLED', ], ], 'TableUnaggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'UnaggregatedFieldList', ], ], ], 'TableVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'TableConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'TableConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'Tags', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'Tags' => [ 'shape' => 'ColumnTagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetVisualList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 50, 'min' => 1, ], 'TargetVisualOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', ], ], 'Template' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Version' => [ 'shape' => 'TemplateVersion', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TemplateAlias' => [ 'type' => 'structure', 'members' => [ 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'TemplateAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateAlias', ], 'max' => 100, ], 'TemplateError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'TemplateErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'TemplateErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateError', ], 'min' => 1, ], 'TemplateErrorType' => [ 'type' => 'string', 'enum' => [ 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'ACCESS_DENIED', ], ], 'TemplateName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TemplateSourceAnalysis' => [ 'type' => 'structure', 'required' => [ 'Arn', 'DataSetReferences', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], ], ], 'TemplateSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceAnalysis' => [ 'shape' => 'TemplateSourceAnalysis', ], 'SourceTemplate' => [ 'shape' => 'TemplateSourceTemplate', ], ], ], 'TemplateSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'TemplateSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'TemplateName', ], 'LatestVersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TemplateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateSummary', ], 'max' => 100, ], 'TemplateVersion' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Errors' => [ 'shape' => 'TemplateErrorList', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'DataSetConfigurations' => [ 'shape' => 'DataSetConfigurationList', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'TemplateVersionDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetConfigurations', ], 'members' => [ 'DataSetConfigurations' => [ 'shape' => 'DataSetConfigurationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], 'QueryExecutionOptions' => [ 'shape' => 'QueryExecutionOptions', ], ], ], 'TemplateVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Description' => [ 'shape' => 'VersionDescription', ], ], ], 'TemplateVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateVersionSummary', ], 'max' => 100, ], 'TeradataParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'TextAreaControlDelimiter' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TextAreaControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'PlaceholderOptions' => [ 'shape' => 'TextControlPlaceholderOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'TextConditionalFormat' => [ 'type' => 'structure', 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'TextControlPlaceholderOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'TextFieldControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'PlaceholderOptions' => [ 'shape' => 'TextControlPlaceholderOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'TextQualifier' => [ 'type' => 'string', 'enum' => [ 'DOUBLE_QUOTE', 'SINGLE_QUOTE', ], ], 'TextWrap' => [ 'type' => 'string', 'enum' => [ 'NONE', 'WRAP', ], ], 'Theme' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ThemeName', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Version' => [ 'shape' => 'ThemeVersion', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Type' => [ 'shape' => 'ThemeType', ], ], ], 'ThemeAlias' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AliasName' => [ 'shape' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'ThemeAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeAlias', ], 'max' => 100, ], 'ThemeConfiguration' => [ 'type' => 'structure', 'members' => [ 'DataColorPalette' => [ 'shape' => 'DataColorPalette', ], 'UIColorPalette' => [ 'shape' => 'UIColorPalette', ], 'Sheet' => [ 'shape' => 'SheetStyle', ], 'Typography' => [ 'shape' => 'Typography', ], ], ], 'ThemeError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ThemeErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'ThemeErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeError', ], 'min' => 1, ], 'ThemeErrorType' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_FAILURE', ], ], 'ThemeName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ThemeSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ThemeName', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'LatestVersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ThemeSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeSummary', ], 'max' => 100, ], 'ThemeType' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT', 'CUSTOM', 'ALL', ], ], 'ThemeVersion' => [ 'type' => 'structure', 'members' => [ 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Arn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], 'Errors' => [ 'shape' => 'ThemeErrorList', ], 'Status' => [ 'shape' => 'ResourceStatus', ], ], ], 'ThemeVersionSummary' => [ 'type' => 'structure', 'members' => [ 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Arn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ResourceStatus', ], ], ], 'ThemeVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeVersionSummary', ], 'max' => 100, ], 'ThousandSeparatorOptions' => [ 'type' => 'structure', 'members' => [ 'Symbol' => [ 'shape' => 'NumericSeparatorSymbol', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TileLayoutStyle' => [ 'type' => 'structure', 'members' => [ 'Gutter' => [ 'shape' => 'GutterStyle', ], 'Margin' => [ 'shape' => 'MarginStyle', ], ], ], 'TileStyle' => [ 'type' => 'structure', 'members' => [ 'Border' => [ 'shape' => 'BorderStyle', ], ], ], 'TimeBasedForecastProperties' => [ 'type' => 'structure', 'members' => [ 'PeriodsForward' => [ 'shape' => 'PeriodsForward', 'box' => true, ], 'PeriodsBackward' => [ 'shape' => 'PeriodsBackward', 'box' => true, ], 'UpperBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'LowerBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'PredictionInterval' => [ 'shape' => 'PredictionInterval', 'box' => true, ], 'Seasonality' => [ 'shape' => 'Seasonality', 'box' => true, ], ], ], 'TimeEqualityFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Timestamp', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TimeGranularity' => [ 'type' => 'string', 'enum' => [ 'YEAR', 'QUARTER', 'MONTH', 'WEEK', 'DAY', 'HOUR', 'MINUTE', 'SECOND', 'MILLISECOND', ], ], 'TimeRangeDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'RangeMinimum', 'RangeMaximum', 'TimeGranularity', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'RangeMinimum' => [ 'shape' => 'Timestamp', ], 'RangeMaximum' => [ 'shape' => 'Timestamp', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'TimeRangeFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeMinimum' => [ 'shape' => 'Boolean', 'box' => true, ], 'IncludeMaximum' => [ 'shape' => 'Boolean', 'box' => true, ], 'RangeMinimumValue' => [ 'shape' => 'TimeRangeFilterValue', ], 'RangeMaximumValue' => [ 'shape' => 'TimeRangeFilterValue', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'ExcludePeriodConfiguration' => [ 'shape' => 'ExcludePeriodConfiguration', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TimeRangeFilterValue' => [ 'type' => 'structure', 'members' => [ 'StaticValue' => [ 'shape' => 'Timestamp', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], 'Parameter' => [ 'shape' => 'ParameterName', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooltipItem' => [ 'type' => 'structure', 'members' => [ 'FieldTooltipItem' => [ 'shape' => 'FieldTooltipItem', ], 'ColumnTooltipItem' => [ 'shape' => 'ColumnTooltipItem', ], ], ], 'TooltipItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TooltipItem', ], 'max' => 100, ], 'TooltipOptions' => [ 'type' => 'structure', 'members' => [ 'TooltipVisibility' => [ 'shape' => 'Visibility', ], 'SelectedTooltipType' => [ 'shape' => 'SelectedTooltipType', ], 'FieldBasedTooltip' => [ 'shape' => 'FieldBasedTooltip', ], ], ], 'TooltipTarget' => [ 'type' => 'string', 'enum' => [ 'BOTH', 'BAR', 'LINE', ], ], 'TooltipTitleType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIMARY_VALUE', ], ], 'TopBottomComputationType' => [ 'type' => 'string', 'enum' => [ 'TOP', 'BOTTOM', ], ], 'TopBottomFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'AggregationSortConfigurations', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'Integer', 'box' => true, ], 'AggregationSortConfigurations' => [ 'shape' => 'AggregationSortConfigurationList', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TopBottomMoversComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Category' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'MoverSize' => [ 'shape' => 'TopBottomMoversComputationMoverSize', ], 'SortOrder' => [ 'shape' => 'TopBottomSortOrder', ], 'Type' => [ 'shape' => 'TopBottomComputationType', ], ], ], 'TopBottomMoversComputationMoverSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'TopBottomRankedComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Category' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'ResultSize' => [ 'shape' => 'TopBottomRankedComputationResultSize', ], 'Type' => [ 'shape' => 'TopBottomComputationType', ], ], ], 'TopBottomRankedComputationResultSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'TopBottomSortOrder' => [ 'type' => 'string', 'enum' => [ 'PERCENT_DIFFERENCE', 'ABSOLUTE_DIFFERENCE', ], ], 'TopicCalculatedField' => [ 'type' => 'structure', 'required' => [ 'CalculatedFieldName', 'Expression', ], 'members' => [ 'CalculatedFieldName' => [ 'shape' => 'LimitedString', ], 'CalculatedFieldDescription' => [ 'shape' => 'LimitedString', ], 'Expression' => [ 'shape' => 'Expression', ], 'CalculatedFieldSynonyms' => [ 'shape' => 'Synonyms', ], 'IsIncludedInTopic' => [ 'shape' => 'Boolean', ], 'DisableIndexing' => [ 'shape' => 'NullableBoolean', ], 'ColumnDataRole' => [ 'shape' => 'ColumnDataRole', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'DefaultFormatting' => [ 'shape' => 'DefaultFormatting', ], 'Aggregation' => [ 'shape' => 'DefaultAggregation', ], 'ComparativeOrder' => [ 'shape' => 'ComparativeOrder', ], 'SemanticType' => [ 'shape' => 'SemanticType', ], 'AllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NotAllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NeverAggregateInFilter' => [ 'shape' => 'Boolean', ], 'CellValueSynonyms' => [ 'shape' => 'CellValueSynonyms', ], 'NonAdditive' => [ 'shape' => 'NullableBoolean', ], ], ], 'TopicCalculatedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicCalculatedField', ], ], 'TopicCategoryFilter' => [ 'type' => 'structure', 'members' => [ 'CategoryFilterFunction' => [ 'shape' => 'CategoryFilterFunction', ], 'CategoryFilterType' => [ 'shape' => 'CategoryFilterType', ], 'Constant' => [ 'shape' => 'TopicCategoryFilterConstant', ], 'Inverse' => [ 'shape' => 'Boolean', ], ], ], 'TopicCategoryFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], 'CollectiveConstant' => [ 'shape' => 'CollectiveConstant', ], ], 'sensitive' => true, ], 'TopicColumn' => [ 'type' => 'structure', 'required' => [ 'ColumnName', ], 'members' => [ 'ColumnName' => [ 'shape' => 'LimitedString', ], 'ColumnFriendlyName' => [ 'shape' => 'LimitedString', ], 'ColumnDescription' => [ 'shape' => 'LimitedString', ], 'ColumnSynonyms' => [ 'shape' => 'Synonyms', ], 'ColumnDataRole' => [ 'shape' => 'ColumnDataRole', ], 'Aggregation' => [ 'shape' => 'DefaultAggregation', ], 'IsIncludedInTopic' => [ 'shape' => 'Boolean', ], 'DisableIndexing' => [ 'shape' => 'NullableBoolean', ], 'ComparativeOrder' => [ 'shape' => 'ComparativeOrder', ], 'SemanticType' => [ 'shape' => 'SemanticType', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'AllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NotAllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'DefaultFormatting' => [ 'shape' => 'DefaultFormatting', ], 'NeverAggregateInFilter' => [ 'shape' => 'Boolean', ], 'CellValueSynonyms' => [ 'shape' => 'CellValueSynonyms', ], 'NonAdditive' => [ 'shape' => 'NullableBoolean', ], ], ], 'TopicColumns' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicColumn', ], ], 'TopicConstantValue' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'Value' => [ 'shape' => 'ConstantValueString', ], 'Minimum' => [ 'shape' => 'ConstantValueString', ], 'Maximum' => [ 'shape' => 'ConstantValueString', ], 'ValueList' => [ 'shape' => 'CollectiveConstantEntryList', ], ], ], 'TopicDateRangeFilter' => [ 'type' => 'structure', 'members' => [ 'Inclusive' => [ 'shape' => 'Boolean', ], 'Constant' => [ 'shape' => 'TopicRangeFilterConstant', ], ], ], 'TopicDetails' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ResourceName', ], 'Description' => [ 'shape' => 'LimitedString', ], 'UserExperienceVersion' => [ 'shape' => 'TopicUserExperienceVersion', ], 'DataSets' => [ 'shape' => 'Datasets', ], ], ], 'TopicFilter' => [ 'type' => 'structure', 'required' => [ 'FilterName', 'OperandFieldName', ], 'members' => [ 'FilterDescription' => [ 'shape' => 'LimitedString', ], 'FilterClass' => [ 'shape' => 'FilterClass', ], 'FilterName' => [ 'shape' => 'LimitedString', ], 'FilterSynonyms' => [ 'shape' => 'Synonyms', ], 'OperandFieldName' => [ 'shape' => 'LimitedString', ], 'FilterType' => [ 'shape' => 'NamedFilterType', ], 'CategoryFilter' => [ 'shape' => 'TopicCategoryFilter', ], 'NumericEqualityFilter' => [ 'shape' => 'TopicNumericEqualityFilter', ], 'NumericRangeFilter' => [ 'shape' => 'TopicNumericRangeFilter', ], 'DateRangeFilter' => [ 'shape' => 'TopicDateRangeFilter', ], 'RelativeDateFilter' => [ 'shape' => 'TopicRelativeDateFilter', ], ], ], 'TopicFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicFilter', ], ], 'TopicIR' => [ 'type' => 'structure', 'members' => [ 'Metrics' => [ 'shape' => 'TopicIRMetricList', ], 'GroupByList' => [ 'shape' => 'TopicIRGroupByList', ], 'Filters' => [ 'shape' => 'TopicIRFilterList', ], 'Sort' => [ 'shape' => 'TopicSortClause', ], 'ContributionAnalysis' => [ 'shape' => 'TopicIRContributionAnalysis', ], 'Visual' => [ 'shape' => 'VisualOptions', ], ], ], 'TopicIRComparisonMethod' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ComparisonMethodType', ], 'Period' => [ 'shape' => 'TopicTimeGranularity', ], 'WindowSize' => [ 'shape' => 'Integer', ], ], ], 'TopicIRContributionAnalysis' => [ 'type' => 'structure', 'members' => [ 'Factors' => [ 'shape' => 'ContributionAnalysisFactorsList', ], 'TimeRanges' => [ 'shape' => 'ContributionAnalysisTimeRanges', ], 'Direction' => [ 'shape' => 'ContributionAnalysisDirection', ], 'SortType' => [ 'shape' => 'ContributionAnalysisSortType', ], ], ], 'TopicIRFilterEntry' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRFilterOption', ], 'max' => 2000, ], 'TopicIRFilterFunction' => [ 'type' => 'string', 'enum' => [ 'CONTAINS', 'EXACT', 'STARTS_WITH', 'ENDS_WITH', 'CONTAINS_STRING', 'PREVIOUS', 'THIS', 'LAST', 'NEXT', 'NOW', ], ], 'TopicIRFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRFilterEntry', ], 'max' => 2000, ], 'TopicIRFilterOption' => [ 'type' => 'structure', 'members' => [ 'FilterType' => [ 'shape' => 'TopicIRFilterType', ], 'FilterClass' => [ 'shape' => 'FilterClass', ], 'OperandField' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'TopicIRFilterFunction', ], 'Constant' => [ 'shape' => 'TopicConstantValue', ], 'Inverse' => [ 'shape' => 'Boolean', ], 'NullFilter' => [ 'shape' => 'NullFilterOption', ], 'Aggregation' => [ 'shape' => 'AggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggFunctionParamMap', ], 'AggregationPartitionBy' => [ 'shape' => 'AggregationPartitionByList', ], 'Range' => [ 'shape' => 'TopicConstantValue', ], 'Inclusive' => [ 'shape' => 'Boolean', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'LastNextOffset' => [ 'shape' => 'TopicConstantValue', ], 'AggMetrics' => [ 'shape' => 'FilterAggMetricsList', ], 'TopBottomLimit' => [ 'shape' => 'TopicConstantValue', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], 'Anchor' => [ 'shape' => 'Anchor', ], ], ], 'TopicIRFilterType' => [ 'type' => 'string', 'enum' => [ 'CATEGORY_FILTER', 'NUMERIC_EQUALITY_FILTER', 'NUMERIC_RANGE_FILTER', 'DATE_RANGE_FILTER', 'RELATIVE_DATE_FILTER', 'TOP_BOTTOM_FILTER', 'EQUALS', 'RANK_LIMIT_FILTER', 'ACCEPT_ALL_FILTER', ], ], 'TopicIRGroupBy' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'Identifier', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'Sort' => [ 'shape' => 'TopicSortClause', ], 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], 'NamedEntity' => [ 'shape' => 'NamedEntityRef', ], ], ], 'TopicIRGroupByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRGroupBy', ], 'max' => 2000, ], 'TopicIRMetric' => [ 'type' => 'structure', 'members' => [ 'MetricId' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'AggFunction', ], 'Operands' => [ 'shape' => 'OperandList', ], 'ComparisonMethod' => [ 'shape' => 'TopicIRComparisonMethod', ], 'Expression' => [ 'shape' => 'Expression', ], 'CalculatedFieldReferences' => [ 'shape' => 'CalculatedFieldReferenceList', ], 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], 'NamedEntity' => [ 'shape' => 'NamedEntityRef', ], ], ], 'TopicIRMetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRMetric', ], 'max' => 2000, ], 'TopicId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[A-Za-z0-9-_.\\\\+]*$', ], 'TopicNamedEntities' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicNamedEntity', ], ], 'TopicNamedEntity' => [ 'type' => 'structure', 'required' => [ 'EntityName', ], 'members' => [ 'EntityName' => [ 'shape' => 'LimitedString', ], 'EntityDescription' => [ 'shape' => 'LimitedString', ], 'EntitySynonyms' => [ 'shape' => 'Synonyms', ], 'SemanticEntityType' => [ 'shape' => 'SemanticEntityType', ], 'Definition' => [ 'shape' => 'NamedEntityDefinitions', ], ], ], 'TopicNumericEqualityFilter' => [ 'type' => 'structure', 'members' => [ 'Constant' => [ 'shape' => 'TopicSingularFilterConstant', ], 'Aggregation' => [ 'shape' => 'NamedFilterAggType', ], ], ], 'TopicNumericRangeFilter' => [ 'type' => 'structure', 'members' => [ 'Inclusive' => [ 'shape' => 'Boolean', ], 'Constant' => [ 'shape' => 'TopicRangeFilterConstant', ], 'Aggregation' => [ 'shape' => 'NamedFilterAggType', ], ], ], 'TopicNumericSeparatorSymbol' => [ 'type' => 'string', 'enum' => [ 'COMMA', 'DOT', ], ], 'TopicRangeFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'RangeConstant' => [ 'shape' => 'RangeConstant', ], ], 'sensitive' => true, ], 'TopicRefreshDetails' => [ 'type' => 'structure', 'members' => [ 'RefreshArn' => [ 'shape' => 'Arn', ], 'RefreshId' => [ 'shape' => 'ResourceId', ], 'RefreshStatus' => [ 'shape' => 'TopicRefreshStatus', ], ], ], 'TopicRefreshSchedule' => [ 'type' => 'structure', 'required' => [ 'IsEnabled', 'BasedOnSpiceSchedule', ], 'members' => [ 'IsEnabled' => [ 'shape' => 'NullableBoolean', ], 'BasedOnSpiceSchedule' => [ 'shape' => 'Boolean', ], 'StartingAt' => [ 'shape' => 'Timestamp', ], 'Timezone' => [ 'shape' => 'LimitedString', ], 'RepeatAt' => [ 'shape' => 'LimitedString', ], 'TopicScheduleType' => [ 'shape' => 'TopicScheduleType', ], ], ], 'TopicRefreshScheduleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicRefreshScheduleSummary', ], ], 'TopicRefreshScheduleSummary' => [ 'type' => 'structure', 'members' => [ 'DatasetId' => [ 'shape' => 'LimitedString', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'LimitedString', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'TopicRefreshStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'RUNNING', 'FAILED', 'COMPLETED', 'CANCELLED', ], ], 'TopicRelativeDateFilter' => [ 'type' => 'structure', 'members' => [ 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'RelativeDateFilterFunction' => [ 'shape' => 'TopicRelativeDateFilterFunction', ], 'Constant' => [ 'shape' => 'TopicSingularFilterConstant', ], ], ], 'TopicRelativeDateFilterFunction' => [ 'type' => 'string', 'enum' => [ 'PREVIOUS', 'THIS', 'LAST', 'NEXT', 'NOW', ], ], 'TopicReviewedAnswer' => [ 'type' => 'structure', 'required' => [ 'AnswerId', 'DatasetArn', 'Question', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnswerId' => [ 'shape' => 'AnswerId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Question' => [ 'shape' => 'LimitedString', ], 'Mir' => [ 'shape' => 'TopicIR', ], 'PrimaryVisual' => [ 'shape' => 'TopicVisual', ], 'Template' => [ 'shape' => 'TopicTemplate', ], ], ], 'TopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicReviewedAnswer', ], ], 'TopicScheduleType' => [ 'type' => 'string', 'enum' => [ 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'TopicSingularFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], ], 'sensitive' => true, ], 'TopicSortClause' => [ 'type' => 'structure', 'members' => [ 'Operand' => [ 'shape' => 'Identifier', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], ], ], 'TopicSortDirection' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'TopicSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicSummary', ], ], 'TopicSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'UserExperienceVersion' => [ 'shape' => 'TopicUserExperienceVersion', ], ], ], 'TopicTemplate' => [ 'type' => 'structure', 'members' => [ 'TemplateType' => [ 'shape' => 'LimitedString', ], 'Slots' => [ 'shape' => 'Slots', ], ], ], 'TopicTimeGranularity' => [ 'type' => 'string', 'enum' => [ 'SECOND', 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', ], ], 'TopicUserExperienceVersion' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'NEW_READER_EXPERIENCE', ], ], 'TopicVisual' => [ 'type' => 'structure', 'members' => [ 'VisualId' => [ 'shape' => 'LimitedString', ], 'Role' => [ 'shape' => 'VisualRole', ], 'Ir' => [ 'shape' => 'TopicIR', ], 'SupportingVisuals' => [ 'shape' => 'TopicVisuals', ], ], ], 'TopicVisuals' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicVisual', ], ], 'TotalAggregationComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'MeasureField', ], ], ], 'TotalAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleTotalAggregationFunction' => [ 'shape' => 'SimpleTotalAggregationFunction', ], ], ], 'TotalAggregationOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'TotalAggregationFunction', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TotalAggregationFunction' => [ 'shape' => 'TotalAggregationFunction', ], ], ], 'TotalAggregationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TotalAggregationOption', ], 'max' => 200, ], 'TotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'Placement' => [ 'shape' => 'TableTotalsPlacement', ], 'ScrollStatus' => [ 'shape' => 'TableTotalsScrollStatus', ], 'CustomLabel' => [ 'shape' => 'String', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'TotalAggregationOptions' => [ 'shape' => 'TotalAggregationOptionList', ], ], ], 'TransformOperation' => [ 'type' => 'structure', 'members' => [ 'ProjectOperation' => [ 'shape' => 'ProjectOperation', ], 'FilterOperation' => [ 'shape' => 'FilterOperation', ], 'CreateColumnsOperation' => [ 'shape' => 'CreateColumnsOperation', ], 'RenameColumnOperation' => [ 'shape' => 'RenameColumnOperation', ], 'CastColumnTypeOperation' => [ 'shape' => 'CastColumnTypeOperation', ], 'TagColumnOperation' => [ 'shape' => 'TagColumnOperation', ], 'UntagColumnOperation' => [ 'shape' => 'UntagColumnOperation', ], 'OverrideDatasetParameterOperation' => [ 'shape' => 'OverrideDatasetParameterOperation', ], ], ], 'TransformOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformOperation', ], 'max' => 2048, 'min' => 1, ], 'TreeMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'TreeMapDimensionFieldList', ], 'Sizes' => [ 'shape' => 'TreeMapMeasureFieldList', ], 'Colors' => [ 'shape' => 'TreeMapMeasureFieldList', ], ], ], 'TreeMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'TreeMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'TreeMapSortConfiguration', ], 'GroupLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SizeLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorScale' => [ 'shape' => 'ColorScale', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'TreeMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'TreeMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'TreeMapAggregatedFieldWells' => [ 'shape' => 'TreeMapAggregatedFieldWells', ], ], ], 'TreeMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'TreeMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'TreeMapSort' => [ 'shape' => 'FieldSortOptionsList', ], 'TreeMapGroupItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'TreeMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'TreeMapConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'TrendArrowOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'TrinoParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], ], ], 'TwitterParameters' => [ 'type' => 'structure', 'required' => [ 'Query', 'MaxRows', ], 'members' => [ 'Query' => [ 'shape' => 'Query', ], 'MaxRows' => [ 'shape' => 'PositiveInteger', ], ], ], 'TypeCastFormat' => [ 'type' => 'string', 'max' => 32, ], 'TypeParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'LimitedString', ], 'value' => [ 'shape' => 'LimitedString', ], ], 'Typography' => [ 'type' => 'structure', 'members' => [ 'FontFamilies' => [ 'shape' => 'FontList', ], ], ], 'UIColorPalette' => [ 'type' => 'structure', 'members' => [ 'PrimaryForeground' => [ 'shape' => 'HexColor', ], 'PrimaryBackground' => [ 'shape' => 'HexColor', ], 'SecondaryForeground' => [ 'shape' => 'HexColor', ], 'SecondaryBackground' => [ 'shape' => 'HexColor', ], 'Accent' => [ 'shape' => 'HexColor', ], 'AccentForeground' => [ 'shape' => 'HexColor', ], 'Danger' => [ 'shape' => 'HexColor', ], 'DangerForeground' => [ 'shape' => 'HexColor', ], 'Warning' => [ 'shape' => 'HexColor', ], 'WarningForeground' => [ 'shape' => 'HexColor', ], 'Success' => [ 'shape' => 'HexColor', ], 'SuccessForeground' => [ 'shape' => 'HexColor', ], 'Dimension' => [ 'shape' => 'HexColor', ], 'DimensionForeground' => [ 'shape' => 'HexColor', ], 'Measure' => [ 'shape' => 'HexColor', ], 'MeasureForeground' => [ 'shape' => 'HexColor', ], ], ], 'URLOperationTemplate' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'URLTargetConfiguration' => [ 'type' => 'string', 'enum' => [ 'NEW_TAB', 'NEW_WINDOW', 'SAME_TAB', ], ], 'UnaggregatedField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'FormatConfiguration' => [ 'shape' => 'FormatConfiguration', ], ], ], 'UnaggregatedFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnaggregatedField', ], 'max' => 200, ], 'UndefinedSpecifiedValueType' => [ 'type' => 'string', 'enum' => [ 'LEAST', 'MOST', ], ], 'UnicodeIcon' => [ 'type' => 'string', 'pattern' => '^[^\\u0000-\\u00FF]$', ], 'UniqueValuesComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Category' => [ 'shape' => 'DimensionField', ], ], ], 'UnlimitedPixelLength' => [ 'type' => 'string', ], 'UnsupportedPricingPlanException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'UnsupportedUserEditionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'UntagColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'TagNames', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'TagNames' => [ 'shape' => 'ColumnTagNames', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'keys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AccountCustomization', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], ], ], 'UpdateAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAccountSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DefaultNamespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DefaultNamespace' => [ 'shape' => 'Namespace', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'TerminationProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdateAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAnalysisPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateAnalysisPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisArn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'SourceEntity' => [ 'shape' => 'AnalysisSourceEntity', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UpdateStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDashboardLinksRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'LinkEntities', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'UpdateDashboardLinksResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'UpdateDashboardPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'GrantLinkPermissions' => [ 'shape' => 'UpdateLinkPermissionList', ], 'RevokeLinkPermissions' => [ 'shape' => 'UpdateLinkPermissionList', ], ], ], 'UpdateDashboardPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], ], ], 'UpdateDashboardPublishedVersionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'VersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'uri', 'locationName' => 'VersionNumber', ], ], ], 'UpdateDashboardPublishedVersionResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'SourceEntity' => [ 'shape' => 'DashboardSourceEntity', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDataSetPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateDataSetPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetArn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'Name', 'PhysicalTableMap', 'ImportMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], ], ], 'UpdateDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'IngestionArn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSourcePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateDataSourcePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'Credentials' => [ 'shape' => 'DataSourceCredentials', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'UpdateStatus' => [ 'shape' => 'ResourceStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateFolderPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateFolderPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Name' => [ 'shape' => 'FolderName', ], ], ], 'UpdateFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], ], ], 'UpdateIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentId' => [ 'shape' => 'String', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIdentityPropagationConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Service', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Service' => [ 'shape' => 'ServiceType', 'location' => 'uri', 'locationName' => 'Service', ], 'AuthorizedTargets' => [ 'shape' => 'AuthorizedTargetsList', ], ], ], 'UpdateIdentityPropagationConfigResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIpRestrictionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'IpRestrictionRuleMap' => [ 'shape' => 'IpRestrictionRuleMap', ], 'VpcIdRestrictionRuleMap' => [ 'shape' => 'VpcIdRestrictionRuleMap', ], 'VpcEndpointIdRestrictionRuleMap' => [ 'shape' => 'VpcEndpointIdRestrictionRuleMap', ], 'Enabled' => [ 'shape' => 'NullableBoolean', ], ], ], 'UpdateIpRestrictionResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateKeyRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'KeyRegistration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'KeyRegistration' => [ 'shape' => 'KeyRegistration', ], ], ], 'UpdateKeyRegistrationResponse' => [ 'type' => 'structure', 'members' => [ 'FailedKeyRegistration' => [ 'shape' => 'FailedKeyRegistrationEntries', ], 'SuccessfulKeyRegistration' => [ 'shape' => 'SuccessfulKeyRegistrationEntries', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], ], ], 'UpdateLinkPermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 100, ], 'UpdatePublicSharingSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'PublicSharingEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePublicSharingSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'Schedule', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Schedule' => [ 'shape' => 'RefreshSchedule', ], ], ], 'UpdateRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'UpdateResourcePermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 100, ], 'UpdateRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CustomPermissionsName', 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'UpdateRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'UpdateSPICECapacityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'PurchaseMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'PurchaseMode' => [ 'shape' => 'PurchaseMode', ], ], ], 'UpdateSPICECapacityConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', 'TemplateVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTemplatePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateTemplatePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'SourceEntity' => [ 'shape' => 'TemplateSourceEntity', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', 'ThemeVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateThemePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateThemePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'BaseThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'Name' => [ 'shape' => 'ThemeName', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], ], ], 'UpdateThemeResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateTopicPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', 'RefreshSchedule', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'UpdateTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Topic', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], ], ], 'UpdateTopicResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'Arn' => [ 'shape' => 'Arn', ], 'RefreshArn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', 'Email', 'Role', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Email' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'UserRole', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'UnapplyCustomPermissions' => [ 'shape' => 'Boolean', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'CustomFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], ], ], 'UpdateUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', 'Name', 'SubnetIds', 'SecurityGroupIds', 'RoleArn', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'UpdateStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UploadSettings' => [ 'type' => 'structure', 'members' => [ 'Format' => [ 'shape' => 'FileFormat', ], 'StartFromRow' => [ 'shape' => 'PositiveInteger', 'box' => true, ], 'ContainsHeader' => [ 'shape' => 'Boolean', 'box' => true, ], 'TextQualifier' => [ 'shape' => 'TextQualifier', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'UserName' => [ 'shape' => 'UserName', ], 'Email' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'UserRole', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Active' => [ 'shape' => 'Boolean', ], 'PrincipalId' => [ 'shape' => 'String', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'ExternalLoginFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], ], ], 'UserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'UserName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'UserRole' => [ 'type' => 'string', 'enum' => [ 'ADMIN', 'AUTHOR', 'READER', 'RESTRICTED_AUTHOR', 'RESTRICTED_READER', 'ADMIN_PRO', 'AUTHOR_PRO', 'READER_PRO', ], ], 'VPCConnection' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResourceName', ], 'VPCId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'NetworkInterfaces' => [ 'shape' => 'NetworkInterfaceList', ], 'RoleArn' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'VPCConnectionAvailabilityStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNAVAILABLE', 'PARTIALLY_AVAILABLE', ], ], 'VPCConnectionResourceIdRestricted' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'VPCConnectionResourceIdUnrestricted' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'VPCConnectionResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'CREATION_SUCCESSFUL', 'CREATION_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_FAILED', 'DELETED', ], ], 'VPCConnectionSummary' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResourceName', ], 'VPCId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'NetworkInterfaces' => [ 'shape' => 'NetworkInterfaceList', ], 'RoleArn' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'VPCConnectionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VPCConnectionSummary', ], ], 'ValidationStrategy' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'ValidationStrategyMode', ], ], ], 'ValidationStrategyMode' => [ 'type' => 'string', 'enum' => [ 'STRICT', 'LENIENT', ], ], 'ValueWhenUnsetOption' => [ 'type' => 'string', 'enum' => [ 'RECOMMENDED_VALUE', 'NULL', ], ], 'VersionDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'VersionNumber' => [ 'type' => 'long', 'min' => 1, ], 'VerticalTextAlignment' => [ 'type' => 'string', 'enum' => [ 'TOP', 'MIDDLE', 'BOTTOM', 'AUTO', ], ], 'Visibility' => [ 'type' => 'string', 'enum' => [ 'HIDDEN', 'VISIBLE', ], ], 'VisiblePanelColumns' => [ 'type' => 'long', 'max' => 10, 'min' => 1, ], 'VisiblePanelRows' => [ 'type' => 'long', 'max' => 10, 'min' => 1, ], 'VisibleRangeOptions' => [ 'type' => 'structure', 'members' => [ 'PercentRange' => [ 'shape' => 'PercentVisibleRange', ], ], ], 'Visual' => [ 'type' => 'structure', 'members' => [ 'TableVisual' => [ 'shape' => 'TableVisual', ], 'PivotTableVisual' => [ 'shape' => 'PivotTableVisual', ], 'BarChartVisual' => [ 'shape' => 'BarChartVisual', ], 'KPIVisual' => [ 'shape' => 'KPIVisual', ], 'PieChartVisual' => [ 'shape' => 'PieChartVisual', ], 'GaugeChartVisual' => [ 'shape' => 'GaugeChartVisual', ], 'LineChartVisual' => [ 'shape' => 'LineChartVisual', ], 'HeatMapVisual' => [ 'shape' => 'HeatMapVisual', ], 'TreeMapVisual' => [ 'shape' => 'TreeMapVisual', ], 'GeospatialMapVisual' => [ 'shape' => 'GeospatialMapVisual', ], 'FilledMapVisual' => [ 'shape' => 'FilledMapVisual', ], 'FunnelChartVisual' => [ 'shape' => 'FunnelChartVisual', ], 'ScatterPlotVisual' => [ 'shape' => 'ScatterPlotVisual', ], 'ComboChartVisual' => [ 'shape' => 'ComboChartVisual', ], 'BoxPlotVisual' => [ 'shape' => 'BoxPlotVisual', ], 'WaterfallVisual' => [ 'shape' => 'WaterfallVisual', ], 'HistogramVisual' => [ 'shape' => 'HistogramVisual', ], 'WordCloudVisual' => [ 'shape' => 'WordCloudVisual', ], 'InsightVisual' => [ 'shape' => 'InsightVisual', ], 'SankeyDiagramVisual' => [ 'shape' => 'SankeyDiagramVisual', ], 'CustomContentVisual' => [ 'shape' => 'CustomContentVisual', ], 'EmptyVisual' => [ 'shape' => 'EmptyVisual', ], 'RadarChartVisual' => [ 'shape' => 'RadarChartVisual', ], ], ], 'VisualAxisSortOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'VisualCustomAction' => [ 'type' => 'structure', 'required' => [ 'CustomActionId', 'Name', 'Trigger', 'ActionOperations', ], 'members' => [ 'CustomActionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'VisualCustomActionName', ], 'Status' => [ 'shape' => 'WidgetStatus', ], 'Trigger' => [ 'shape' => 'VisualCustomActionTrigger', ], 'ActionOperations' => [ 'shape' => 'VisualCustomActionOperationList', ], ], ], 'VisualCustomActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisualCustomAction', ], 'max' => 10, ], 'VisualCustomActionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'VisualCustomActionOperation' => [ 'type' => 'structure', 'members' => [ 'FilterOperation' => [ 'shape' => 'CustomActionFilterOperation', ], 'NavigationOperation' => [ 'shape' => 'CustomActionNavigationOperation', ], 'URLOperation' => [ 'shape' => 'CustomActionURLOperation', ], 'SetParametersOperation' => [ 'shape' => 'CustomActionSetParametersOperation', ], ], ], 'VisualCustomActionOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisualCustomActionOperation', ], 'max' => 2, 'min' => 1, ], 'VisualCustomActionTrigger' => [ 'type' => 'string', 'enum' => [ 'DATA_POINT_CLICK', 'DATA_POINT_MENU', ], ], 'VisualInteractionOptions' => [ 'type' => 'structure', 'members' => [ 'VisualMenuOption' => [ 'shape' => 'VisualMenuOption', ], 'ContextMenuOption' => [ 'shape' => 'ContextMenuOption', ], ], ], 'VisualList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Visual', ], 'max' => 50, ], 'VisualMenuOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'VisualOptions' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'LimitedString', ], ], ], 'VisualPalette' => [ 'type' => 'structure', 'members' => [ 'ChartColor' => [ 'shape' => 'HexColor', ], 'ColorMap' => [ 'shape' => 'DataPathColorList', ], ], ], 'VisualRole' => [ 'type' => 'string', 'enum' => [ 'PRIMARY', 'COMPLIMENTARY', 'MULTI_INTENT', 'FALLBACK', 'FRAGMENT', ], ], 'VisualSubtitleLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FormatText' => [ 'shape' => 'LongFormatText', ], ], ], 'VisualTitleLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FormatText' => [ 'shape' => 'ShortFormatText', ], ], ], 'VpcConnectionProperties' => [ 'type' => 'structure', 'required' => [ 'VpcConnectionArn', ], 'members' => [ 'VpcConnectionArn' => [ 'shape' => 'Arn', ], ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'VpcEndpointIdRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'VpcEndpointIdRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'VpcEndpointId', ], 'value' => [ 'shape' => 'VpcEndpointIdRestrictionRuleDescription', ], ], 'VpcId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpc-[0-9a-z]*$', ], 'VpcIdRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'VpcIdRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'VpcId', ], 'value' => [ 'shape' => 'VpcIdRestrictionRuleDescription', ], ], 'Warehouse' => [ 'type' => 'string', 'max' => 128, ], 'WaterfallChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Categories' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Breakdowns' => [ 'shape' => 'DimensionFieldList', ], ], ], 'WaterfallChartColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'GroupColorConfiguration' => [ 'shape' => 'WaterfallChartGroupColorConfiguration', ], ], ], 'WaterfallChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'WaterfallChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'WaterfallChartSortConfiguration', ], 'WaterfallChartOptions' => [ 'shape' => 'WaterfallChartOptions', ], 'CategoryAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'CategoryAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ColorConfiguration' => [ 'shape' => 'WaterfallChartColorConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'WaterfallChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'WaterfallChartAggregatedFieldWells' => [ 'shape' => 'WaterfallChartAggregatedFieldWells', ], ], ], 'WaterfallChartGroupColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'PositiveBarColor' => [ 'shape' => 'HexColor', ], 'NegativeBarColor' => [ 'shape' => 'HexColor', ], 'TotalBarColor' => [ 'shape' => 'HexColor', ], ], ], 'WaterfallChartOptions' => [ 'type' => 'structure', 'members' => [ 'TotalBarLabel' => [ 'shape' => 'String', ], ], ], 'WaterfallChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'BreakdownItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'WaterfallVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'WaterfallChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'WhatIfPointScenario' => [ 'type' => 'structure', 'required' => [ 'Date', 'Value', ], 'members' => [ 'Date' => [ 'shape' => 'Timestamp', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'WhatIfRangeScenario' => [ 'type' => 'structure', 'required' => [ 'StartDate', 'EndDate', 'Value', ], 'members' => [ 'StartDate' => [ 'shape' => 'Timestamp', ], 'EndDate' => [ 'shape' => 'Timestamp', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'WidgetStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'WordCloudAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'WordCloudDimensionFieldList', ], 'Size' => [ 'shape' => 'WordCloudMeasureFieldList', ], ], ], 'WordCloudChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'WordCloudFieldWells', ], 'SortConfiguration' => [ 'shape' => 'WordCloudSortConfiguration', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'WordCloudOptions' => [ 'shape' => 'WordCloudOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'WordCloudCloudLayout' => [ 'type' => 'string', 'enum' => [ 'FLUID', 'NORMAL', ], ], 'WordCloudDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 10, ], 'WordCloudFieldWells' => [ 'type' => 'structure', 'members' => [ 'WordCloudAggregatedFieldWells' => [ 'shape' => 'WordCloudAggregatedFieldWells', ], ], ], 'WordCloudMaximumStringLength' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'WordCloudMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'WordCloudOptions' => [ 'type' => 'structure', 'members' => [ 'WordOrientation' => [ 'shape' => 'WordCloudWordOrientation', ], 'WordScaling' => [ 'shape' => 'WordCloudWordScaling', ], 'CloudLayout' => [ 'shape' => 'WordCloudCloudLayout', ], 'WordCasing' => [ 'shape' => 'WordCloudWordCasing', ], 'WordPadding' => [ 'shape' => 'WordCloudWordPadding', ], 'MaximumStringLength' => [ 'shape' => 'WordCloudMaximumStringLength', ], ], ], 'WordCloudSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'WordCloudVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'WordCloudChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'WordCloudWordCasing' => [ 'type' => 'string', 'enum' => [ 'LOWER_CASE', 'EXISTING_CASE', ], ], 'WordCloudWordOrientation' => [ 'type' => 'string', 'enum' => [ 'HORIZONTAL', 'HORIZONTAL_AND_VERTICAL', ], ], 'WordCloudWordPadding' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SMALL', 'MEDIUM', 'LARGE', ], ], 'WordCloudWordScaling' => [ 'type' => 'string', 'enum' => [ 'EMPHASIZE', 'NORMAL', ], ], 'WorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'YAxisOptions' => [ 'type' => 'structure', 'required' => [ 'YAxis', ], 'members' => [ 'YAxis' => [ 'shape' => 'SingleYAxisOption', ], ], ], 'boolean' => [ 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-04-01', 'endpointPrefix' => 'quicksight', 'jsonVersion' => '1.0', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon QuickSight', 'serviceId' => 'QuickSight', 'signatureVersion' => 'v4', 'uid' => 'quicksight-2018-04-01', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'BatchCreateTopicReviewedAnswer' => [ 'name' => 'BatchCreateTopicReviewedAnswer', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers', ], 'input' => [ 'shape' => 'BatchCreateTopicReviewedAnswerRequest', ], 'output' => [ 'shape' => 'BatchCreateTopicReviewedAnswerResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'BatchDeleteTopicReviewedAnswer' => [ 'name' => 'BatchDeleteTopicReviewedAnswer', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers', ], 'input' => [ 'shape' => 'BatchDeleteTopicReviewedAnswerRequest', ], 'output' => [ 'shape' => 'BatchDeleteTopicReviewedAnswerResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CancelIngestion' => [ 'name' => 'CancelIngestion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'CancelIngestionRequest', ], 'output' => [ 'shape' => 'CancelIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateAccountCustomization' => [ 'name' => 'CreateAccountCustomization', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'CreateAccountCustomizationRequest', ], 'output' => [ 'shape' => 'CreateAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateAccountSubscription' => [ 'name' => 'CreateAccountSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'CreateAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'CreateAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateAnalysis' => [ 'name' => 'CreateAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'CreateAnalysisRequest', ], 'output' => [ 'shape' => 'CreateAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDashboard' => [ 'name' => 'CreateDashboard', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'CreateDashboardRequest', ], 'output' => [ 'shape' => 'CreateDashboardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDataSet' => [ 'name' => 'CreateDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets', ], 'input' => [ 'shape' => 'CreateDataSetRequest', ], 'output' => [ 'shape' => 'CreateDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateDataSource' => [ 'name' => 'CreateDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sources', ], 'input' => [ 'shape' => 'CreateDataSourceRequest', ], 'output' => [ 'shape' => 'CreateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'CustomerManagedKeyUnavailableException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateFolder' => [ 'name' => 'CreateFolder', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'CreateFolderRequest', ], 'output' => [ 'shape' => 'CreateFolderResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateFolderMembership' => [ 'name' => 'CreateFolderMembership', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}', ], 'input' => [ 'shape' => 'CreateFolderMembershipRequest', ], 'output' => [ 'shape' => 'CreateFolderMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateGroupMembership' => [ 'name' => 'CreateGroupMembership', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'CreateGroupMembershipRequest', ], 'output' => [ 'shape' => 'CreateGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateIAMPolicyAssignment' => [ 'name' => 'CreateIAMPolicyAssignment', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/', ], 'input' => [ 'shape' => 'CreateIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'CreateIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateIngestion' => [ 'name' => 'CreateIngestion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'CreateIngestionRequest', ], 'output' => [ 'shape' => 'CreateIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateNamespace' => [ 'name' => 'CreateNamespace', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}', ], 'input' => [ 'shape' => 'CreateNamespaceRequest', ], 'output' => [ 'shape' => 'CreateNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateRefreshSchedule' => [ 'name' => 'CreateRefreshSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'CreateRefreshScheduleRequest', ], 'output' => [ 'shape' => 'CreateRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateRoleMembership' => [ 'name' => 'CreateRoleMembership', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}', ], 'input' => [ 'shape' => 'CreateRoleMembershipRequest', ], 'output' => [ 'shape' => 'CreateRoleMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'CreateTemplate' => [ 'name' => 'CreateTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'CreateTemplateRequest', ], 'output' => [ 'shape' => 'CreateTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTemplateAlias' => [ 'name' => 'CreateTemplateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'CreateTemplateAliasRequest', ], 'output' => [ 'shape' => 'CreateTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTheme' => [ 'name' => 'CreateTheme', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'CreateThemeRequest', ], 'output' => [ 'shape' => 'CreateThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateThemeAlias' => [ 'name' => 'CreateThemeAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'CreateThemeAliasRequest', ], 'output' => [ 'shape' => 'CreateThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTopic' => [ 'name' => 'CreateTopic', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics', ], 'input' => [ 'shape' => 'CreateTopicRequest', ], 'output' => [ 'shape' => 'CreateTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateTopicRefreshSchedule' => [ 'name' => 'CreateTopicRefreshSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules', ], 'input' => [ 'shape' => 'CreateTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'CreateTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'CreateVPCConnection' => [ 'name' => 'CreateVPCConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections', ], 'input' => [ 'shape' => 'CreateVPCConnectionRequest', ], 'output' => [ 'shape' => 'CreateVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteAccountCustomization' => [ 'name' => 'DeleteAccountCustomization', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'DeleteAccountCustomizationRequest', ], 'output' => [ 'shape' => 'DeleteAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteAccountSubscription' => [ 'name' => 'DeleteAccountSubscription', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'DeleteAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'DeleteAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteAnalysis' => [ 'name' => 'DeleteAnalysis', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'DeleteAnalysisRequest', ], 'output' => [ 'shape' => 'DeleteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDashboard' => [ 'name' => 'DeleteDashboard', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'DeleteDashboardRequest', ], 'output' => [ 'shape' => 'DeleteDashboardResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSet' => [ 'name' => 'DeleteDataSet', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'DeleteDataSetRequest', ], 'output' => [ 'shape' => 'DeleteDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSetRefreshProperties' => [ 'name' => 'DeleteDataSetRefreshProperties', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'DeleteDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'DeleteDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteFolder' => [ 'name' => 'DeleteFolder', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'DeleteFolderRequest', ], 'output' => [ 'shape' => 'DeleteFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteFolderMembership' => [ 'name' => 'DeleteFolderMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}', ], 'input' => [ 'shape' => 'DeleteFolderMembershipRequest', ], 'output' => [ 'shape' => 'DeleteFolderMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteGroupMembership' => [ 'name' => 'DeleteGroupMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'DeleteGroupMembershipRequest', ], 'output' => [ 'shape' => 'DeleteGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteIAMPolicyAssignment' => [ 'name' => 'DeleteIAMPolicyAssignment', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'DeleteIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'DeleteIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteIdentityPropagationConfig' => [ 'name' => 'DeleteIdentityPropagationConfig', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config/{Service}', ], 'input' => [ 'shape' => 'DeleteIdentityPropagationConfigRequest', ], 'output' => [ 'shape' => 'DeleteIdentityPropagationConfigResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteNamespace' => [ 'name' => 'DeleteNamespace', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}', ], 'input' => [ 'shape' => 'DeleteNamespaceRequest', ], 'output' => [ 'shape' => 'DeleteNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteRefreshSchedule' => [ 'name' => 'DeleteRefreshSchedule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}', ], 'input' => [ 'shape' => 'DeleteRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DeleteRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteRoleCustomPermission' => [ 'name' => 'DeleteRoleCustomPermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'DeleteRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'DeleteRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteRoleMembership' => [ 'name' => 'DeleteRoleMembership', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}', ], 'input' => [ 'shape' => 'DeleteRoleMembershipRequest', ], 'output' => [ 'shape' => 'DeleteRoleMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteTemplate' => [ 'name' => 'DeleteTemplate', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'DeleteTemplateRequest', ], 'output' => [ 'shape' => 'DeleteTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTemplateAlias' => [ 'name' => 'DeleteTemplateAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DeleteTemplateAliasRequest', ], 'output' => [ 'shape' => 'DeleteTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTheme' => [ 'name' => 'DeleteTheme', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'DeleteThemeRequest', ], 'output' => [ 'shape' => 'DeleteThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteThemeAlias' => [ 'name' => 'DeleteThemeAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DeleteThemeAliasRequest', ], 'output' => [ 'shape' => 'DeleteThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTopic' => [ 'name' => 'DeleteTopic', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'DeleteTopicRequest', ], 'output' => [ 'shape' => 'DeleteTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteTopicRefreshSchedule' => [ 'name' => 'DeleteTopicRefreshSchedule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'DeleteTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DeleteTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteUserByPrincipalId' => [ 'name' => 'DeleteUserByPrincipalId', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}', ], 'input' => [ 'shape' => 'DeleteUserByPrincipalIdRequest', ], 'output' => [ 'shape' => 'DeleteUserByPrincipalIdResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DeleteVPCConnection' => [ 'name' => 'DeleteVPCConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'DeleteVPCConnectionRequest', ], 'output' => [ 'shape' => 'DeleteVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAccountCustomization' => [ 'name' => 'DescribeAccountCustomization', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'DescribeAccountCustomizationRequest', ], 'output' => [ 'shape' => 'DescribeAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAccountSettings' => [ 'name' => 'DescribeAccountSettings', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/settings', ], 'input' => [ 'shape' => 'DescribeAccountSettingsRequest', ], 'output' => [ 'shape' => 'DescribeAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAccountSubscription' => [ 'name' => 'DescribeAccountSubscription', 'http' => [ 'method' => 'GET', 'requestUri' => '/account/{AwsAccountId}', ], 'input' => [ 'shape' => 'DescribeAccountSubscriptionRequest', ], 'output' => [ 'shape' => 'DescribeAccountSubscriptionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeAnalysis' => [ 'name' => 'DescribeAnalysis', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'DescribeAnalysisRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAnalysisDefinition' => [ 'name' => 'DescribeAnalysisDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition', ], 'input' => [ 'shape' => 'DescribeAnalysisDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAnalysisPermissions' => [ 'name' => 'DescribeAnalysisPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions', ], 'input' => [ 'shape' => 'DescribeAnalysisPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeAnalysisPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeAssetBundleExportJob' => [ 'name' => 'DescribeAssetBundleExportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}', ], 'input' => [ 'shape' => 'DescribeAssetBundleExportJobRequest', ], 'output' => [ 'shape' => 'DescribeAssetBundleExportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeAssetBundleImportJob' => [ 'name' => 'DescribeAssetBundleImportJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}', ], 'input' => [ 'shape' => 'DescribeAssetBundleImportJobRequest', ], 'output' => [ 'shape' => 'DescribeAssetBundleImportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeDashboard' => [ 'name' => 'DescribeDashboard', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'DescribeDashboardRequest', ], 'output' => [ 'shape' => 'DescribeDashboardResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardDefinition' => [ 'name' => 'DescribeDashboardDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition', ], 'input' => [ 'shape' => 'DescribeDashboardDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDashboardDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardPermissions' => [ 'name' => 'DescribeDashboardPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions', ], 'input' => [ 'shape' => 'DescribeDashboardPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDashboardPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardSnapshotJob' => [ 'name' => 'DescribeDashboardSnapshotJob', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}', ], 'input' => [ 'shape' => 'DescribeDashboardSnapshotJobRequest', ], 'output' => [ 'shape' => 'DescribeDashboardSnapshotJobResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDashboardSnapshotJobResult' => [ 'name' => 'DescribeDashboardSnapshotJobResult', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result', ], 'input' => [ 'shape' => 'DescribeDashboardSnapshotJobResultRequest', ], 'output' => [ 'shape' => 'DescribeDashboardSnapshotJobResultResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSet' => [ 'name' => 'DescribeDataSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'DescribeDataSetRequest', ], 'output' => [ 'shape' => 'DescribeDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSetPermissions' => [ 'name' => 'DescribeDataSetPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions', ], 'input' => [ 'shape' => 'DescribeDataSetPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDataSetPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSetRefreshProperties' => [ 'name' => 'DescribeDataSetRefreshProperties', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'DescribeDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'DescribeDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSource' => [ 'name' => 'DescribeDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'DescribeDataSourceRequest', ], 'output' => [ 'shape' => 'DescribeDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeDataSourcePermissions' => [ 'name' => 'DescribeDataSourcePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions', ], 'input' => [ 'shape' => 'DescribeDataSourcePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeDataSourcePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolder' => [ 'name' => 'DescribeFolder', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'DescribeFolderRequest', ], 'output' => [ 'shape' => 'DescribeFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolderPermissions' => [ 'name' => 'DescribeFolderPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/permissions', ], 'input' => [ 'shape' => 'DescribeFolderPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeFolderPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeFolderResolvedPermissions' => [ 'name' => 'DescribeFolderResolvedPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions', ], 'input' => [ 'shape' => 'DescribeFolderResolvedPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeFolderResolvedPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeGroup' => [ 'name' => 'DescribeGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'DescribeGroupRequest', ], 'output' => [ 'shape' => 'DescribeGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeGroupMembership' => [ 'name' => 'DescribeGroupMembership', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}', ], 'input' => [ 'shape' => 'DescribeGroupMembershipRequest', ], 'output' => [ 'shape' => 'DescribeGroupMembershipResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeIAMPolicyAssignment' => [ 'name' => 'DescribeIAMPolicyAssignment', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'DescribeIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'DescribeIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeIngestion' => [ 'name' => 'DescribeIngestion', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}', ], 'input' => [ 'shape' => 'DescribeIngestionRequest', ], 'output' => [ 'shape' => 'DescribeIngestionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeIpRestriction' => [ 'name' => 'DescribeIpRestriction', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/ip-restriction', ], 'input' => [ 'shape' => 'DescribeIpRestrictionRequest', ], 'output' => [ 'shape' => 'DescribeIpRestrictionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeKeyRegistration' => [ 'name' => 'DescribeKeyRegistration', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/key-registration', ], 'input' => [ 'shape' => 'DescribeKeyRegistrationRequest', ], 'output' => [ 'shape' => 'DescribeKeyRegistrationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeNamespace' => [ 'name' => 'DescribeNamespace', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}', ], 'input' => [ 'shape' => 'DescribeNamespaceRequest', ], 'output' => [ 'shape' => 'DescribeNamespaceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeRefreshSchedule' => [ 'name' => 'DescribeRefreshSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}', ], 'input' => [ 'shape' => 'DescribeRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DescribeRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeRoleCustomPermission' => [ 'name' => 'DescribeRoleCustomPermission', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'DescribeRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'DescribeRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeTemplate' => [ 'name' => 'DescribeTemplate', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'DescribeTemplateRequest', ], 'output' => [ 'shape' => 'DescribeTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplateAlias' => [ 'name' => 'DescribeTemplateAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DescribeTemplateAliasRequest', ], 'output' => [ 'shape' => 'DescribeTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplateDefinition' => [ 'name' => 'DescribeTemplateDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/definition', ], 'input' => [ 'shape' => 'DescribeTemplateDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTemplateDefinitionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTemplatePermissions' => [ 'name' => 'DescribeTemplatePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/permissions', ], 'input' => [ 'shape' => 'DescribeTemplatePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeTemplatePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTheme' => [ 'name' => 'DescribeTheme', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'DescribeThemeRequest', ], 'output' => [ 'shape' => 'DescribeThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeThemeAlias' => [ 'name' => 'DescribeThemeAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'DescribeThemeAliasRequest', ], 'output' => [ 'shape' => 'DescribeThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeThemePermissions' => [ 'name' => 'DescribeThemePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/permissions', ], 'input' => [ 'shape' => 'DescribeThemePermissionsRequest', ], 'output' => [ 'shape' => 'DescribeThemePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopic' => [ 'name' => 'DescribeTopic', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'DescribeTopicRequest', ], 'output' => [ 'shape' => 'DescribeTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicPermissions' => [ 'name' => 'DescribeTopicPermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/permissions', ], 'input' => [ 'shape' => 'DescribeTopicPermissionsRequest', ], 'output' => [ 'shape' => 'DescribeTopicPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicRefresh' => [ 'name' => 'DescribeTopicRefresh', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}', ], 'input' => [ 'shape' => 'DescribeTopicRefreshRequest', ], 'output' => [ 'shape' => 'DescribeTopicRefreshResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeTopicRefreshSchedule' => [ 'name' => 'DescribeTopicRefreshSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'DescribeTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'DescribeTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'DescribeVPCConnection' => [ 'name' => 'DescribeVPCConnection', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'DescribeVPCConnectionRequest', ], 'output' => [ 'shape' => 'DescribeVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GenerateEmbedUrlForAnonymousUser' => [ 'name' => 'GenerateEmbedUrlForAnonymousUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/embed-url/anonymous-user', ], 'input' => [ 'shape' => 'GenerateEmbedUrlForAnonymousUserRequest', ], 'output' => [ 'shape' => 'GenerateEmbedUrlForAnonymousUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GenerateEmbedUrlForRegisteredUser' => [ 'name' => 'GenerateEmbedUrlForRegisteredUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/embed-url/registered-user', ], 'input' => [ 'shape' => 'GenerateEmbedUrlForRegisteredUserRequest', ], 'output' => [ 'shape' => 'GenerateEmbedUrlForRegisteredUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GetDashboardEmbedUrl' => [ 'name' => 'GetDashboardEmbedUrl', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url', ], 'input' => [ 'shape' => 'GetDashboardEmbedUrlRequest', ], 'output' => [ 'shape' => 'GetDashboardEmbedUrlResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'DomainNotWhitelistedException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'IdentityTypeNotSupportedException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GetSessionEmbedUrl' => [ 'name' => 'GetSessionEmbedUrl', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/session-embed-url', ], 'input' => [ 'shape' => 'GetSessionEmbedUrlRequest', ], 'output' => [ 'shape' => 'GetSessionEmbedUrlResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'QuickSightUserNotFoundException', ], [ 'shape' => 'SessionLifetimeInMinutesInvalidException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListAnalyses' => [ 'name' => 'ListAnalyses', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/analyses', ], 'input' => [ 'shape' => 'ListAnalysesRequest', ], 'output' => [ 'shape' => 'ListAnalysesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListAssetBundleExportJobs' => [ 'name' => 'ListAssetBundleExportJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs', ], 'input' => [ 'shape' => 'ListAssetBundleExportJobsRequest', ], 'output' => [ 'shape' => 'ListAssetBundleExportJobsResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAssetBundleImportJobs' => [ 'name' => 'ListAssetBundleImportJobs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs', ], 'input' => [ 'shape' => 'ListAssetBundleImportJobsRequest', ], 'output' => [ 'shape' => 'ListAssetBundleImportJobsResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDashboardVersions' => [ 'name' => 'ListDashboardVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions', ], 'input' => [ 'shape' => 'ListDashboardVersionsRequest', ], 'output' => [ 'shape' => 'ListDashboardVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDashboards' => [ 'name' => 'ListDashboards', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/dashboards', ], 'input' => [ 'shape' => 'ListDashboardsRequest', ], 'output' => [ 'shape' => 'ListDashboardsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDataSets' => [ 'name' => 'ListDataSets', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets', ], 'input' => [ 'shape' => 'ListDataSetsRequest', ], 'output' => [ 'shape' => 'ListDataSetsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sources', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListFolderMembers' => [ 'name' => 'ListFolderMembers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/members', ], 'input' => [ 'shape' => 'ListFolderMembersRequest', ], 'output' => [ 'shape' => 'ListFolderMembersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListFolders' => [ 'name' => 'ListFolders', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/folders', ], 'input' => [ 'shape' => 'ListFoldersRequest', ], 'output' => [ 'shape' => 'ListFoldersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListGroupMemberships' => [ 'name' => 'ListGroupMemberships', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members', ], 'input' => [ 'shape' => 'ListGroupMembershipsRequest', ], 'output' => [ 'shape' => 'ListGroupMembershipsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListIAMPolicyAssignments' => [ 'name' => 'ListIAMPolicyAssignments', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments', ], 'input' => [ 'shape' => 'ListIAMPolicyAssignmentsRequest', ], 'output' => [ 'shape' => 'ListIAMPolicyAssignmentsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIAMPolicyAssignmentsForUser' => [ 'name' => 'ListIAMPolicyAssignmentsForUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments', ], 'input' => [ 'shape' => 'ListIAMPolicyAssignmentsForUserRequest', ], 'output' => [ 'shape' => 'ListIAMPolicyAssignmentsForUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIdentityPropagationConfigs' => [ 'name' => 'ListIdentityPropagationConfigs', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config', ], 'input' => [ 'shape' => 'ListIdentityPropagationConfigsRequest', ], 'output' => [ 'shape' => 'ListIdentityPropagationConfigsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListIngestions' => [ 'name' => 'ListIngestions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions', ], 'input' => [ 'shape' => 'ListIngestionsRequest', ], 'output' => [ 'shape' => 'ListIngestionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListNamespaces' => [ 'name' => 'ListNamespaces', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces', ], 'input' => [ 'shape' => 'ListNamespacesRequest', ], 'output' => [ 'shape' => 'ListNamespacesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListRefreshSchedules' => [ 'name' => 'ListRefreshSchedules', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'ListRefreshSchedulesRequest', ], 'output' => [ 'shape' => 'ListRefreshSchedulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListRoleMemberships' => [ 'name' => 'ListRoleMemberships', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members', ], 'input' => [ 'shape' => 'ListRoleMembershipsRequest', ], 'output' => [ 'shape' => 'ListRoleMembershipsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplateAliases' => [ 'name' => 'ListTemplateAliases', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases', ], 'input' => [ 'shape' => 'ListTemplateAliasesRequest', ], 'output' => [ 'shape' => 'ListTemplateAliasesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplateVersions' => [ 'name' => 'ListTemplateVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/versions', ], 'input' => [ 'shape' => 'ListTemplateVersionsRequest', ], 'output' => [ 'shape' => 'ListTemplateVersionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTemplates' => [ 'name' => 'ListTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/templates', ], 'input' => [ 'shape' => 'ListTemplatesRequest', ], 'output' => [ 'shape' => 'ListTemplatesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemeAliases' => [ 'name' => 'ListThemeAliases', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases', ], 'input' => [ 'shape' => 'ListThemeAliasesRequest', ], 'output' => [ 'shape' => 'ListThemeAliasesResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemeVersions' => [ 'name' => 'ListThemeVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/versions', ], 'input' => [ 'shape' => 'ListThemeVersionsRequest', ], 'output' => [ 'shape' => 'ListThemeVersionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListThemes' => [ 'name' => 'ListThemes', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/themes', ], 'input' => [ 'shape' => 'ListThemesRequest', ], 'output' => [ 'shape' => 'ListThemesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopicRefreshSchedules' => [ 'name' => 'ListTopicRefreshSchedules', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules', ], 'input' => [ 'shape' => 'ListTopicRefreshSchedulesRequest', ], 'output' => [ 'shape' => 'ListTopicRefreshSchedulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopicReviewedAnswers' => [ 'name' => 'ListTopicReviewedAnswers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers', ], 'input' => [ 'shape' => 'ListTopicReviewedAnswersRequest', ], 'output' => [ 'shape' => 'ListTopicReviewedAnswersResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListTopics' => [ 'name' => 'ListTopics', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/topics', ], 'input' => [ 'shape' => 'ListTopicsRequest', ], 'output' => [ 'shape' => 'ListTopicsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'ListUserGroups' => [ 'name' => 'ListUserGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups', ], 'input' => [ 'shape' => 'ListUserGroupsRequest', ], 'output' => [ 'shape' => 'ListUserGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'ListVPCConnections' => [ 'name' => 'ListVPCConnections', 'http' => [ 'method' => 'GET', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections', ], 'input' => [ 'shape' => 'ListVPCConnectionsRequest', ], 'output' => [ 'shape' => 'ListVPCConnectionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'PutDataSetRefreshProperties' => [ 'name' => 'PutDataSetRefreshProperties', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties', ], 'input' => [ 'shape' => 'PutDataSetRefreshPropertiesRequest', ], 'output' => [ 'shape' => 'PutDataSetRefreshPropertiesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'RegisterUser' => [ 'name' => 'RegisterUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users', ], 'input' => [ 'shape' => 'RegisterUserRequest', ], 'output' => [ 'shape' => 'RegisterUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'RestoreAnalysis' => [ 'name' => 'RestoreAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'RestoreAnalysisRequest', ], 'output' => [ 'shape' => 'RestoreAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchAnalyses' => [ 'name' => 'SearchAnalyses', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/analyses', ], 'input' => [ 'shape' => 'SearchAnalysesRequest', ], 'output' => [ 'shape' => 'SearchAnalysesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDashboards' => [ 'name' => 'SearchDashboards', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/dashboards', ], 'input' => [ 'shape' => 'SearchDashboardsRequest', ], 'output' => [ 'shape' => 'SearchDashboardsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDataSets' => [ 'name' => 'SearchDataSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/data-sets', ], 'input' => [ 'shape' => 'SearchDataSetsRequest', ], 'output' => [ 'shape' => 'SearchDataSetsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchDataSources' => [ 'name' => 'SearchDataSources', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/data-sources', ], 'input' => [ 'shape' => 'SearchDataSourcesRequest', ], 'output' => [ 'shape' => 'SearchDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchFolders' => [ 'name' => 'SearchFolders', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/search/folders', ], 'input' => [ 'shape' => 'SearchFoldersRequest', ], 'output' => [ 'shape' => 'SearchFoldersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'SearchGroups' => [ 'name' => 'SearchGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search', ], 'input' => [ 'shape' => 'SearchGroupsRequest', ], 'output' => [ 'shape' => 'SearchGroupsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'StartAssetBundleExportJob' => [ 'name' => 'StartAssetBundleExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-export-jobs/export', ], 'input' => [ 'shape' => 'StartAssetBundleExportJobRequest', ], 'output' => [ 'shape' => 'StartAssetBundleExportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StartAssetBundleImportJob' => [ 'name' => 'StartAssetBundleImportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/asset-bundle-import-jobs/import', ], 'input' => [ 'shape' => 'StartAssetBundleImportJobRequest', ], 'output' => [ 'shape' => 'StartAssetBundleImportJobResponse', ], 'errors' => [ [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StartDashboardSnapshotJob' => [ 'name' => 'StartDashboardSnapshotJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs', ], 'input' => [ 'shape' => 'StartDashboardSnapshotJobRequest', ], 'output' => [ 'shape' => 'StartDashboardSnapshotJobResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/resources/{ResourceArn}/tags', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateAccountCustomization' => [ 'name' => 'UpdateAccountCustomization', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/customizations', ], 'input' => [ 'shape' => 'UpdateAccountCustomizationRequest', ], 'output' => [ 'shape' => 'UpdateAccountCustomizationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateAccountSettings' => [ 'name' => 'UpdateAccountSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/settings', ], 'input' => [ 'shape' => 'UpdateAccountSettingsRequest', ], 'output' => [ 'shape' => 'UpdateAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateAnalysis' => [ 'name' => 'UpdateAnalysis', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}', ], 'input' => [ 'shape' => 'UpdateAnalysisRequest', ], 'output' => [ 'shape' => 'UpdateAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateAnalysisPermissions' => [ 'name' => 'UpdateAnalysisPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions', ], 'input' => [ 'shape' => 'UpdateAnalysisPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateAnalysisPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboard' => [ 'name' => 'UpdateDashboard', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}', ], 'input' => [ 'shape' => 'UpdateDashboardRequest', ], 'output' => [ 'shape' => 'UpdateDashboardResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardLinks' => [ 'name' => 'UpdateDashboardLinks', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities', ], 'input' => [ 'shape' => 'UpdateDashboardLinksRequest', ], 'output' => [ 'shape' => 'UpdateDashboardLinksResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardPermissions' => [ 'name' => 'UpdateDashboardPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions', ], 'input' => [ 'shape' => 'UpdateDashboardPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDashboardPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDashboardPublishedVersion' => [ 'name' => 'UpdateDashboardPublishedVersion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}', ], 'input' => [ 'shape' => 'UpdateDashboardPublishedVersionRequest', ], 'output' => [ 'shape' => 'UpdateDashboardPublishedVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSet' => [ 'name' => 'UpdateDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}', ], 'input' => [ 'shape' => 'UpdateDataSetRequest', ], 'output' => [ 'shape' => 'UpdateDataSetResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSetPermissions' => [ 'name' => 'UpdateDataSetPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions', ], 'input' => [ 'shape' => 'UpdateDataSetPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDataSetPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'CustomerManagedKeyUnavailableException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateDataSourcePermissions' => [ 'name' => 'UpdateDataSourcePermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions', ], 'input' => [ 'shape' => 'UpdateDataSourcePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateDataSourcePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateFolder' => [ 'name' => 'UpdateFolder', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}', ], 'input' => [ 'shape' => 'UpdateFolderRequest', ], 'output' => [ 'shape' => 'UpdateFolderResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateFolderPermissions' => [ 'name' => 'UpdateFolderPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/folders/{FolderId}/permissions', ], 'input' => [ 'shape' => 'UpdateFolderPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateFolderPermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}', ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateIAMPolicyAssignment' => [ 'name' => 'UpdateIAMPolicyAssignment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}', ], 'input' => [ 'shape' => 'UpdateIAMPolicyAssignmentRequest', ], 'output' => [ 'shape' => 'UpdateIAMPolicyAssignmentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConcurrentUpdatingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateIdentityPropagationConfig' => [ 'name' => 'UpdateIdentityPropagationConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/identity-propagation-config/{Service}', ], 'input' => [ 'shape' => 'UpdateIdentityPropagationConfigRequest', ], 'output' => [ 'shape' => 'UpdateIdentityPropagationConfigResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateIpRestriction' => [ 'name' => 'UpdateIpRestriction', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/ip-restriction', ], 'input' => [ 'shape' => 'UpdateIpRestrictionRequest', ], 'output' => [ 'shape' => 'UpdateIpRestrictionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateKeyRegistration' => [ 'name' => 'UpdateKeyRegistration', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/key-registration', ], 'input' => [ 'shape' => 'UpdateKeyRegistrationRequest', ], 'output' => [ 'shape' => 'UpdateKeyRegistrationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdatePublicSharingSettings' => [ 'name' => 'UpdatePublicSharingSettings', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/public-sharing-settings', ], 'input' => [ 'shape' => 'UpdatePublicSharingSettingsRequest', ], 'output' => [ 'shape' => 'UpdatePublicSharingSettingsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedPricingPlanException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateRefreshSchedule' => [ 'name' => 'UpdateRefreshSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules', ], 'input' => [ 'shape' => 'UpdateRefreshScheduleRequest', ], 'output' => [ 'shape' => 'UpdateRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateRoleCustomPermission' => [ 'name' => 'UpdateRoleCustomPermission', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission', ], 'input' => [ 'shape' => 'UpdateRoleCustomPermissionRequest', ], 'output' => [ 'shape' => 'UpdateRoleCustomPermissionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateSPICECapacityConfiguration' => [ 'name' => 'UpdateSPICECapacityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/accounts/{AwsAccountId}/spice-capacity-configuration', ], 'input' => [ 'shape' => 'UpdateSPICECapacityConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateSPICECapacityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplate' => [ 'name' => 'UpdateTemplate', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}', ], 'input' => [ 'shape' => 'UpdateTemplateRequest', ], 'output' => [ 'shape' => 'UpdateTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplateAlias' => [ 'name' => 'UpdateTemplateAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'UpdateTemplateAliasRequest', ], 'output' => [ 'shape' => 'UpdateTemplateAliasResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTemplatePermissions' => [ 'name' => 'UpdateTemplatePermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/templates/{TemplateId}/permissions', ], 'input' => [ 'shape' => 'UpdateTemplatePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateTemplatePermissionsResponse', ], 'errors' => [ [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTheme' => [ 'name' => 'UpdateTheme', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}', ], 'input' => [ 'shape' => 'UpdateThemeRequest', ], 'output' => [ 'shape' => 'UpdateThemeResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateThemeAlias' => [ 'name' => 'UpdateThemeAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}', ], 'input' => [ 'shape' => 'UpdateThemeAliasRequest', ], 'output' => [ 'shape' => 'UpdateThemeAliasResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateThemePermissions' => [ 'name' => 'UpdateThemePermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/themes/{ThemeId}/permissions', ], 'input' => [ 'shape' => 'UpdateThemePermissionsRequest', ], 'output' => [ 'shape' => 'UpdateThemePermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopic' => [ 'name' => 'UpdateTopic', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}', ], 'input' => [ 'shape' => 'UpdateTopicRequest', ], 'output' => [ 'shape' => 'UpdateTopicResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopicPermissions' => [ 'name' => 'UpdateTopicPermissions', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/permissions', ], 'input' => [ 'shape' => 'UpdateTopicPermissionsRequest', ], 'output' => [ 'shape' => 'UpdateTopicPermissionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateTopicRefreshSchedule' => [ 'name' => 'UpdateTopicRefreshSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}', ], 'input' => [ 'shape' => 'UpdateTopicRefreshScheduleRequest', ], 'output' => [ 'shape' => 'UpdateTopicRefreshScheduleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceExistsException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'UpdateUser' => [ 'name' => 'UpdateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}', ], 'input' => [ 'shape' => 'UpdateUserRequest', ], 'output' => [ 'shape' => 'UpdateUserResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'PreconditionNotMetException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'ResourceUnavailableException', ], ], ], 'UpdateVPCConnection' => [ 'name' => 'UpdateVPCConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}', ], 'input' => [ 'shape' => 'UpdateVPCConnectionRequest', ], 'output' => [ 'shape' => 'UpdateVPCConnectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnsupportedUserEditionException', ], [ 'shape' => 'InternalFailureException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'AccountCustomization' => [ 'type' => 'structure', 'members' => [ 'DefaultTheme' => [ 'shape' => 'Arn', ], 'DefaultEmailCustomizationTemplate' => [ 'shape' => 'Arn', ], ], ], 'AccountInfo' => [ 'type' => 'structure', 'members' => [ 'AccountName' => [ 'shape' => 'String', ], 'Edition' => [ 'shape' => 'Edition', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'AuthenticationType' => [ 'shape' => 'String', ], 'AccountSubscriptionStatus' => [ 'shape' => 'String', ], 'IAMIdentityCenterInstanceArn' => [ 'shape' => 'String', ], ], ], 'AccountName' => [ 'type' => 'string', 'max' => 62, 'min' => 1, 'pattern' => '^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*', ], 'AccountSettings' => [ 'type' => 'structure', 'members' => [ 'AccountName' => [ 'shape' => 'String', ], 'Edition' => [ 'shape' => 'Edition', ], 'DefaultNamespace' => [ 'shape' => 'Namespace', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'PublicSharingEnabled' => [ 'shape' => 'Boolean', ], 'TerminationProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'ActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, 'min' => 1, ], 'ActiveIAMPolicyAssignment' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'PolicyArn' => [ 'shape' => 'Arn', ], ], ], 'ActiveIAMPolicyAssignmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActiveIAMPolicyAssignment', ], ], 'AdHocFilteringOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'AdditionalDashboardIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 20, 'min' => 1, ], 'AggFunction' => [ 'type' => 'structure', 'members' => [ 'Aggregation' => [ 'shape' => 'AggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggFunctionParamMap', ], 'Period' => [ 'shape' => 'TopicTimeGranularity', ], 'PeriodField' => [ 'shape' => 'LimitedString', ], ], ], 'AggFunctionParamKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AggFunctionParamMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'AggFunctionParamKey', ], 'value' => [ 'shape' => 'AggFunctionParamValue', ], ], 'AggFunctionParamValue' => [ 'type' => 'string', 'max' => 1024, ], 'AggType' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MIN', 'MAX', 'COUNT', 'AVERAGE', 'DISTINCT_COUNT', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', 'MEDIAN', 'PTD_SUM', 'PTD_MIN', 'PTD_MAX', 'PTD_COUNT', 'PTD_DISTINCT_COUNT', 'PTD_AVERAGE', 'COLUMN', 'CUSTOM', ], ], 'AggregationFunction' => [ 'type' => 'structure', 'members' => [ 'NumericalAggregationFunction' => [ 'shape' => 'NumericalAggregationFunction', ], 'CategoricalAggregationFunction' => [ 'shape' => 'CategoricalAggregationFunction', ], 'DateAggregationFunction' => [ 'shape' => 'DateAggregationFunction', ], 'AttributeAggregationFunction' => [ 'shape' => 'AttributeAggregationFunction', ], ], ], 'AggregationFunctionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'LimitedString', ], 'value' => [ 'shape' => 'LimitedString', ], ], 'AggregationPartitionBy' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'AggregationPartitionByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationPartitionBy', ], 'max' => 50, ], 'AggregationSortConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', 'SortDirection', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'SortDirection' => [ 'shape' => 'SortDirection', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], ], ], 'AggregationSortConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationSortConfiguration', ], 'max' => 100, ], 'AliasName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)', ], 'AllSheetsFilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [], ], 'AmazonElasticsearchParameters' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'Domain', ], ], ], 'AmazonOpenSearchParameters' => [ 'type' => 'structure', 'required' => [ 'Domain', ], 'members' => [ 'Domain' => [ 'shape' => 'Domain', ], ], ], 'Analysis' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Errors' => [ 'shape' => 'AnalysisErrorList', ], 'DataSetArns' => [ 'shape' => 'DataSetArnsList', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'AnalysisDefaults' => [ 'type' => 'structure', 'required' => [ 'DefaultNewSheetConfiguration', ], 'members' => [ 'DefaultNewSheetConfiguration' => [ 'shape' => 'DefaultNewSheetConfiguration', ], ], ], 'AnalysisDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifierDeclarations', ], 'members' => [ 'DataSetIdentifierDeclarations' => [ 'shape' => 'DataSetIdentifierDeclarationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], 'QueryExecutionOptions' => [ 'shape' => 'QueryExecutionOptions', ], ], ], 'AnalysisError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'AnalysisErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'AnalysisErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisError', ], 'min' => 1, ], 'AnalysisErrorType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'PARAMETER_VALUE_INCOMPATIBLE', 'PARAMETER_TYPE_INVALID', 'PARAMETER_NOT_FOUND', 'COLUMN_TYPE_MISMATCH', 'COLUMN_GEOGRAPHIC_ROLE_MISMATCH', 'COLUMN_REPLACEMENT_MISSING', ], ], 'AnalysisFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_USER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'ANALYSIS_NAME', ], ], 'AnalysisName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'AnalysisSearchFilter' => [ 'type' => 'structure', 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'AnalysisFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'AnalysisSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisSearchFilter', ], 'max' => 1, 'min' => 1, ], 'AnalysisSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceTemplate' => [ 'shape' => 'AnalysisSourceTemplate', ], ], ], 'AnalysisSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'DataSetReferences', 'Arn', ], 'members' => [ 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'AnalysisSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AnalysisSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalysisSummary', ], 'max' => 100, ], 'Anchor' => [ 'type' => 'structure', 'members' => [ 'AnchorType' => [ 'shape' => 'AnchorType', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'Offset' => [ 'shape' => 'Integer', ], ], ], 'AnchorDateConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnchorOption' => [ 'shape' => 'AnchorOption', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'AnchorOption' => [ 'type' => 'string', 'enum' => [ 'NOW', ], ], 'AnchorType' => [ 'type' => 'string', 'enum' => [ 'TODAY', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'EnabledFeatures' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures', ], 'DisabledFeatures' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures', ], 'FeatureConfigurations' => [ 'shape' => 'AnonymousUserDashboardFeatureConfigurations', ], ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature' => [ 'type' => 'string', 'enum' => [ 'SHARED_VIEW', ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature' => [ 'type' => 'string', 'enum' => [ 'SHARED_VIEW', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature', ], ], 'AnonymousUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], ], ], 'AnonymousUserDashboardVisualEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardVisualId', ], 'members' => [ 'InitialDashboardVisualId' => [ 'shape' => 'DashboardVisualId', ], ], ], 'AnonymousUserEmbeddingExperienceConfiguration' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'AnonymousUserDashboardEmbeddingConfiguration', ], 'DashboardVisual' => [ 'shape' => 'AnonymousUserDashboardVisualEmbeddingConfiguration', ], 'QSearchBar' => [ 'shape' => 'AnonymousUserQSearchBarEmbeddingConfiguration', ], 'GenerativeQnA' => [ 'shape' => 'AnonymousUserGenerativeQnAEmbeddingConfiguration', ], ], ], 'AnonymousUserGenerativeQnAEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialTopicId', ], 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'AnonymousUserQSearchBarEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialTopicId', ], 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'AnonymousUserSnapshotJobResult' => [ 'type' => 'structure', 'members' => [ 'FileGroups' => [ 'shape' => 'SnapshotJobResultFileGroupList', ], ], ], 'AnonymousUserSnapshotJobResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnonymousUserSnapshotJobResult', ], ], 'AnswerId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[A-Za-z0-9-_.\\\\+]*$', ], 'AnswerIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnswerId', ], ], 'ArcAxisConfiguration' => [ 'type' => 'structure', 'members' => [ 'Range' => [ 'shape' => 'ArcAxisDisplayRange', ], 'ReserveRange' => [ 'shape' => 'Integer', ], ], ], 'ArcAxisDisplayRange' => [ 'type' => 'structure', 'members' => [ 'Min' => [ 'shape' => 'Double', 'box' => true, ], 'Max' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'ArcConfiguration' => [ 'type' => 'structure', 'members' => [ 'ArcAngle' => [ 'shape' => 'Double', 'box' => true, ], 'ArcThickness' => [ 'shape' => 'ArcThicknessOptions', ], ], ], 'ArcOptions' => [ 'type' => 'structure', 'members' => [ 'ArcThickness' => [ 'shape' => 'ArcThickness', ], ], ], 'ArcThickness' => [ 'type' => 'string', 'enum' => [ 'SMALL', 'MEDIUM', 'LARGE', 'WHOLE', ], ], 'ArcThicknessOptions' => [ 'type' => 'string', 'enum' => [ 'SMALL', 'MEDIUM', 'LARGE', ], ], 'Arn' => [ 'type' => 'string', ], 'ArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], ], 'AssetBundleCloudFormationOverridePropertyConfiguration' => [ 'type' => 'structure', 'members' => [ 'ResourceIdOverrideConfiguration' => [ 'shape' => 'AssetBundleExportJobResourceIdOverrideConfiguration', ], 'VPCConnections' => [ 'shape' => 'AssetBundleExportJobVPCConnectionOverridePropertiesList', ], 'RefreshSchedules' => [ 'shape' => 'AssetBundleExportJobRefreshScheduleOverridePropertiesList', ], 'DataSources' => [ 'shape' => 'AssetBundleExportJobDataSourceOverridePropertiesList', ], 'DataSets' => [ 'shape' => 'AssetBundleExportJobDataSetOverridePropertiesList', ], 'Themes' => [ 'shape' => 'AssetBundleExportJobThemeOverridePropertiesList', ], 'Analyses' => [ 'shape' => 'AssetBundleExportJobAnalysisOverridePropertiesList', ], 'Dashboards' => [ 'shape' => 'AssetBundleExportJobDashboardOverridePropertiesList', ], ], ], 'AssetBundleExportFormat' => [ 'type' => 'string', 'enum' => [ 'CLOUDFORMATION_JSON', 'QUICKSIGHT_JSON', ], ], 'AssetBundleExportJobAnalysisOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobAnalysisPropertyToOverrideList', ], ], ], 'AssetBundleExportJobAnalysisOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobAnalysisOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobAnalysisPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobAnalysisPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobAnalysisPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDashboardOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDashboardPropertyToOverrideList', ], ], ], 'AssetBundleExportJobDashboardOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDashboardOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDashboardPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobDashboardPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDashboardPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDataSetOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDataSetPropertyToOverrideList', ], ], ], 'AssetBundleExportJobDataSetOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSetOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDataSetPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobDataSetPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSetPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobDataSourceOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobDataSourcePropertyToOverrideList', ], ], ], 'AssetBundleExportJobDataSourceOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSourceOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobDataSourcePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', 'DisableSsl', 'SecretArn', 'Username', 'Password', 'Domain', 'WorkGroup', 'Host', 'Port', 'Database', 'DataSetName', 'Catalog', 'InstanceId', 'ClusterId', 'ManifestFileLocation', 'Warehouse', 'RoleArn', 'ProductType', ], ], 'AssetBundleExportJobDataSourcePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobDataSourcePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobError' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Type' => [ 'shape' => 'NonEmptyString', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleExportJobErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobError', ], ], 'AssetBundleExportJobRefreshScheduleOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList', ], ], ], 'AssetBundleExportJobRefreshScheduleOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobRefreshScheduleOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobRefreshSchedulePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'StartAfterDateTime', ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobRefreshSchedulePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobResourceIdOverrideConfiguration' => [ 'type' => 'structure', 'members' => [ 'PrefixForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED_FOR_IMMEDIATE_EXECUTION', 'IN_PROGRESS', 'SUCCESSFUL', 'FAILED', ], ], 'AssetBundleExportJobSummary' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleExportJobStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobSummary', ], ], 'AssetBundleExportJobThemeOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobThemePropertyToOverrideList', ], ], ], 'AssetBundleExportJobThemeOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobThemeOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobThemePropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', ], ], 'AssetBundleExportJobThemePropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobThemePropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobVPCConnectionOverrideProperties' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Properties', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Properties' => [ 'shape' => 'AssetBundleExportJobVPCConnectionPropertyToOverrideList', ], ], ], 'AssetBundleExportJobVPCConnectionOverridePropertiesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobVPCConnectionOverrideProperties', ], 'max' => 50, 'min' => 1, ], 'AssetBundleExportJobVPCConnectionPropertyToOverride' => [ 'type' => 'string', 'enum' => [ 'Name', 'DnsResolvers', 'RoleArn', ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverrideList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobVPCConnectionPropertyToOverride', ], 'max' => 10, 'min' => 1, ], 'AssetBundleExportJobValidationStrategy' => [ 'type' => 'structure', 'members' => [ 'StrictModeForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleExportJobWarning' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleExportJobWarningList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleExportJobWarning', ], ], 'AssetBundleImportBodyBlob' => [ 'type' => 'blob', 'max' => 20971520, 'min' => 0, 'sensitive' => true, ], 'AssetBundleImportFailureAction' => [ 'type' => 'string', 'enum' => [ 'DO_NOTHING', 'ROLLBACK', ], ], 'AssetBundleImportJobAnalysisOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'AnalysisId', ], 'members' => [ 'AnalysisId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobAnalysisOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobAnalysisOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'AnalysisIds', 'Permissions', ], 'members' => [ 'AnalysisIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobAnalysisOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverridePermissions', ], 'max' => 1, 'min' => 1, ], 'AssetBundleImportJobAnalysisOverrideTags' => [ 'type' => 'structure', 'required' => [ 'AnalysisIds', 'Tags', ], 'members' => [ 'AnalysisIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobAnalysisOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDashboardOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DashboardId', ], 'members' => [ 'DashboardId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobDashboardOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDashboardOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DashboardIds', ], 'members' => [ 'DashboardIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], 'LinkSharingConfiguration' => [ 'shape' => 'AssetBundleResourceLinkSharingConfiguration', ], ], ], 'AssetBundleImportJobDashboardOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDashboardOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DashboardIds', 'Tags', ], 'members' => [ 'DashboardIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDashboardOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDataSetOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobDataSetOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDataSetOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DataSetIds', 'Permissions', ], 'members' => [ 'DataSetIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobDataSetOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDataSetOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DataSetIds', 'Tags', ], 'members' => [ 'DataSetIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDataSetOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobDataSourceCredentialPair' => [ 'type' => 'structure', 'required' => [ 'Username', 'Password', ], 'members' => [ 'Username' => [ 'shape' => 'DbUsername', ], 'Password' => [ 'shape' => 'Password', ], ], 'sensitive' => true, ], 'AssetBundleImportJobDataSourceCredentials' => [ 'type' => 'structure', 'members' => [ 'CredentialPair' => [ 'shape' => 'AssetBundleImportJobDataSourceCredentialPair', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'AssetBundleImportJobDataSourceOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSourceId', ], 'members' => [ 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'Credentials' => [ 'shape' => 'AssetBundleImportJobDataSourceCredentials', ], ], ], 'AssetBundleImportJobDataSourceOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobDataSourceOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'DataSourceIds', 'Permissions', ], 'members' => [ 'DataSourceIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobDataSourceOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobDataSourceOverrideTags' => [ 'type' => 'structure', 'required' => [ 'DataSourceIds', 'Tags', ], 'members' => [ 'DataSourceIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobDataSourceOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobError' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Type' => [ 'shape' => 'NonEmptyString', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleImportJobErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobError', ], ], 'AssetBundleImportJobOverrideParameters' => [ 'type' => 'structure', 'members' => [ 'ResourceIdOverrideConfiguration' => [ 'shape' => 'AssetBundleImportJobResourceIdOverrideConfiguration', ], 'VPCConnections' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideParametersList', ], 'RefreshSchedules' => [ 'shape' => 'AssetBundleImportJobRefreshScheduleOverrideParametersList', ], 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideParametersList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideParametersList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverrideParametersList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideParametersList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideParametersList', ], ], ], 'AssetBundleImportJobOverridePermissions' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverridePermissionsList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverridePermissionsList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverridePermissionsList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverridePermissionsList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverridePermissionsList', ], ], ], 'AssetBundleImportJobOverrideTags' => [ 'type' => 'structure', 'members' => [ 'VPCConnections' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideTagsList', ], 'DataSources' => [ 'shape' => 'AssetBundleImportJobDataSourceOverrideTagsList', ], 'DataSets' => [ 'shape' => 'AssetBundleImportJobDataSetOverrideTagsList', ], 'Themes' => [ 'shape' => 'AssetBundleImportJobThemeOverrideTagsList', ], 'Analyses' => [ 'shape' => 'AssetBundleImportJobAnalysisOverrideTagsList', ], 'Dashboards' => [ 'shape' => 'AssetBundleImportJobDashboardOverrideTagsList', ], ], ], 'AssetBundleImportJobOverrideValidationStrategy' => [ 'type' => 'structure', 'members' => [ 'StrictModeForAllResources' => [ 'shape' => 'Boolean', ], ], ], 'AssetBundleImportJobRefreshScheduleOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'ScheduleId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', ], 'ScheduleId' => [ 'shape' => 'String', ], 'StartAfterDateTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssetBundleImportJobRefreshScheduleOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobRefreshScheduleOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobResourceIdOverrideConfiguration' => [ 'type' => 'structure', 'members' => [ 'PrefixForAllResources' => [ 'shape' => 'String', ], ], ], 'AssetBundleImportJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED_FOR_IMMEDIATE_EXECUTION', 'IN_PROGRESS', 'SUCCESSFUL', 'FAILED', 'FAILED_ROLLBACK_IN_PROGRESS', 'FAILED_ROLLBACK_COMPLETED', 'FAILED_ROLLBACK_ERROR', ], ], 'AssetBundleImportJobSummary' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleImportJobStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], ], ], 'AssetBundleImportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobSummary', ], ], 'AssetBundleImportJobThemeOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'ThemeId', ], 'members' => [ 'ThemeId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], ], ], 'AssetBundleImportJobThemeOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobThemeOverridePermissions' => [ 'type' => 'structure', 'required' => [ 'ThemeIds', 'Permissions', ], 'members' => [ 'ThemeIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleImportJobThemeOverridePermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverridePermissions', ], 'max' => 2, 'min' => 1, ], 'AssetBundleImportJobThemeOverrideTags' => [ 'type' => 'structure', 'required' => [ 'ThemeIds', 'Tags', ], 'members' => [ 'ThemeIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobThemeOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobThemeOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobVPCConnectionOverrideParameters' => [ 'type' => 'structure', 'required' => [ 'VPCConnectionId', ], 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'AssetBundleImportJobVPCConnectionOverrideParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideParameters', ], 'max' => 50, 'min' => 1, ], 'AssetBundleImportJobVPCConnectionOverrideTags' => [ 'type' => 'structure', 'required' => [ 'VPCConnectionIds', 'Tags', ], 'members' => [ 'VPCConnectionIds' => [ 'shape' => 'AssetBundleRestrictiveResourceIdList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AssetBundleImportJobVPCConnectionOverrideTagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobVPCConnectionOverrideTags', ], 'max' => 5, 'min' => 1, ], 'AssetBundleImportJobWarning' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'AssetBundleImportJobWarningList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleImportJobWarning', ], ], 'AssetBundleImportSource' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'AssetBundleImportBodyBlob', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AssetBundleImportSourceDescription' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'SensitiveS3Uri', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AssetBundlePrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], 'max' => 64, 'min' => 1, ], 'AssetBundleResourceArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, 'min' => 1, ], 'AssetBundleResourceLinkSharingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'AssetBundleResourcePermissions', ], ], ], 'AssetBundleResourcePermissions' => [ 'type' => 'structure', 'required' => [ 'Principals', 'Actions', ], 'members' => [ 'Principals' => [ 'shape' => 'AssetBundlePrincipalList', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'AssetBundleRestrictiveResourceId' => [ 'type' => 'string', 'pattern' => '\\*|[\\w\\-]{1,2048}', ], 'AssetBundleRestrictiveResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssetBundleRestrictiveResourceId', ], 'max' => 50, 'min' => 1, ], 'AssetOptions' => [ 'type' => 'structure', 'members' => [ 'Timezone' => [ 'shape' => 'String', ], 'WeekStart' => [ 'shape' => 'DayOfTheWeek', ], ], ], 'AssignmentStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DRAFT', 'DISABLED', ], ], 'AthenaParameters' => [ 'type' => 'structure', 'members' => [ 'WorkGroup' => [ 'shape' => 'WorkGroup', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'AttributeAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleAttributeAggregation' => [ 'shape' => 'SimpleAttributeAggregationFunction', ], 'ValueForMultipleValues' => [ 'shape' => 'String', ], ], ], 'AuroraParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'AuroraPostgreSqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'AuthenticationMethodOption' => [ 'type' => 'string', 'enum' => [ 'IAM_AND_QUICKSIGHT', 'IAM_ONLY', 'ACTIVE_DIRECTORY', 'IAM_IDENTITY_CENTER', ], ], 'AuthorSpecifiedAggregation' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', 'MIN', 'MAX', 'MEDIAN', 'SUM', 'AVERAGE', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', ], ], 'AuthorSpecifiedAggregations' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorSpecifiedAggregation', ], ], 'AuthorizedTargetsByService' => [ 'type' => 'structure', 'members' => [ 'Service' => [ 'shape' => 'ServiceType', ], 'AuthorizedTargets' => [ 'shape' => 'AuthorizedTargetsList', ], ], ], 'AuthorizedTargetsByServices' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedTargetsByService', ], ], 'AuthorizedTargetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'AwsAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^[0-9]{12}$', ], 'AwsAndAccountId' => [ 'type' => 'string', 'pattern' => '^(aws|[0-9]{12})$', ], 'AwsIotAnalyticsParameters' => [ 'type' => 'structure', 'required' => [ 'DataSetName', ], 'members' => [ 'DataSetName' => [ 'shape' => 'DataSetName', ], ], ], 'AxisBinding' => [ 'type' => 'string', 'enum' => [ 'PRIMARY_YAXIS', 'SECONDARY_YAXIS', ], ], 'AxisDataOptions' => [ 'type' => 'structure', 'members' => [ 'NumericAxisOptions' => [ 'shape' => 'NumericAxisOptions', ], 'DateAxisOptions' => [ 'shape' => 'DateAxisOptions', ], ], ], 'AxisDisplayDataDrivenRange' => [ 'type' => 'structure', 'members' => [], ], 'AxisDisplayMinMaxRange' => [ 'type' => 'structure', 'members' => [ 'Minimum' => [ 'shape' => 'Double', 'box' => true, ], 'Maximum' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TickLabelOptions' => [ 'shape' => 'AxisTickLabelOptions', ], 'AxisLineVisibility' => [ 'shape' => 'Visibility', ], 'GridLineVisibility' => [ 'shape' => 'Visibility', ], 'DataOptions' => [ 'shape' => 'AxisDataOptions', ], 'ScrollbarOptions' => [ 'shape' => 'ScrollBarOptions', ], 'AxisOffset' => [ 'shape' => 'PixelLength', ], ], ], 'AxisDisplayRange' => [ 'type' => 'structure', 'members' => [ 'MinMax' => [ 'shape' => 'AxisDisplayMinMaxRange', ], 'DataDriven' => [ 'shape' => 'AxisDisplayDataDrivenRange', ], ], ], 'AxisLabelOptions' => [ 'type' => 'structure', 'members' => [ 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'CustomLabel' => [ 'shape' => 'String', ], 'ApplyTo' => [ 'shape' => 'AxisLabelReferenceOptions', ], ], ], 'AxisLabelOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AxisLabelOptions', ], 'max' => 100, ], 'AxisLabelReferenceOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'AxisLinearScale' => [ 'type' => 'structure', 'members' => [ 'StepCount' => [ 'shape' => 'Integer', 'box' => true, ], 'StepSize' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisLogarithmicScale' => [ 'type' => 'structure', 'members' => [ 'Base' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'AxisScale' => [ 'type' => 'structure', 'members' => [ 'Linear' => [ 'shape' => 'AxisLinearScale', ], 'Logarithmic' => [ 'shape' => 'AxisLogarithmicScale', ], ], ], 'AxisTickLabelOptions' => [ 'type' => 'structure', 'members' => [ 'LabelOptions' => [ 'shape' => 'LabelOptions', ], 'RotationAngle' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'BarChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'BarChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'BarChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'BarChartSortConfiguration', ], 'Orientation' => [ 'shape' => 'BarChartOrientation', ], 'BarsArrangement' => [ 'shape' => 'BarsArrangement', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'BarChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'BarChartAggregatedFieldWells' => [ 'shape' => 'BarChartAggregatedFieldWells', ], ], ], 'BarChartOrientation' => [ 'type' => 'string', 'enum' => [ 'HORIZONTAL', 'VERTICAL', ], ], 'BarChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'BarChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'BarChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'BarsArrangement' => [ 'type' => 'string', 'enum' => [ 'CLUSTERED', 'STACKED', 'STACKED_PERCENT', ], ], 'BaseMapStyleType' => [ 'type' => 'string', 'enum' => [ 'LIGHT_GRAY', 'DARK_GRAY', 'STREET', 'IMAGERY', ], ], 'BatchCreateTopicReviewedAnswerRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Answers', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'Answers' => [ 'shape' => 'CreateTopicReviewedAnswers', ], ], ], 'BatchCreateTopicReviewedAnswerResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'SucceededAnswers' => [ 'shape' => 'SucceededTopicReviewedAnswers', ], 'InvalidAnswers' => [ 'shape' => 'InvalidTopicReviewedAnswers', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'BatchDeleteTopicReviewedAnswerRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'AnswerIds' => [ 'shape' => 'AnswerIds', ], ], ], 'BatchDeleteTopicReviewedAnswerResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'SucceededAnswers' => [ 'shape' => 'SucceededTopicReviewedAnswers', ], 'InvalidAnswers' => [ 'shape' => 'InvalidTopicReviewedAnswers', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'BigQueryParameters' => [ 'type' => 'structure', 'required' => [ 'ProjectId', ], 'members' => [ 'ProjectId' => [ 'shape' => 'ProjectId', ], 'DataSetRegion' => [ 'shape' => 'DataSetRegion', ], ], ], 'BinCountLimit' => [ 'type' => 'long', 'max' => 1000, 'min' => 0, ], 'BinCountOptions' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'BinCountValue', ], ], ], 'BinCountValue' => [ 'type' => 'integer', 'min' => 0, ], 'BinWidthOptions' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'BinWidthValue', ], 'BinCountLimit' => [ 'shape' => 'BinCountLimit', ], ], ], 'BinWidthValue' => [ 'type' => 'double', 'min' => 0, ], 'BodySectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'SectionId', 'Content', ], 'members' => [ 'SectionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Content' => [ 'shape' => 'BodySectionContent', ], 'Style' => [ 'shape' => 'SectionStyle', ], 'PageBreakConfiguration' => [ 'shape' => 'SectionPageBreakConfiguration', ], 'RepeatConfiguration' => [ 'shape' => 'BodySectionRepeatConfiguration', ], ], ], 'BodySectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionConfiguration', ], 'max' => 28, ], 'BodySectionContent' => [ 'type' => 'structure', 'members' => [ 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], ], ], 'BodySectionDynamicCategoryDimensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'BodySectionDynamicDimensionLimit', 'box' => true, ], 'SortByMetrics' => [ 'shape' => 'BodySectionDynamicDimensionSortConfigurationList', ], ], ], 'BodySectionDynamicDimensionLimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'BodySectionDynamicDimensionSortConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnSort', ], 'max' => 100, ], 'BodySectionDynamicNumericDimensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'BodySectionDynamicDimensionLimit', 'box' => true, ], 'SortByMetrics' => [ 'shape' => 'BodySectionDynamicDimensionSortConfigurationList', ], ], ], 'BodySectionRepeatConfiguration' => [ 'type' => 'structure', 'members' => [ 'DimensionConfigurations' => [ 'shape' => 'BodySectionRepeatDimensionConfigurationList', ], 'PageBreakConfiguration' => [ 'shape' => 'BodySectionRepeatPageBreakConfiguration', ], 'NonRepeatingVisuals' => [ 'shape' => 'NonRepeatingVisualsList', ], ], ], 'BodySectionRepeatDimensionConfiguration' => [ 'type' => 'structure', 'members' => [ 'DynamicCategoryDimensionConfiguration' => [ 'shape' => 'BodySectionDynamicCategoryDimensionConfiguration', ], 'DynamicNumericDimensionConfiguration' => [ 'shape' => 'BodySectionDynamicNumericDimensionConfiguration', ], ], ], 'BodySectionRepeatDimensionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BodySectionRepeatDimensionConfiguration', ], 'max' => 3, ], 'BodySectionRepeatPageBreakConfiguration' => [ 'type' => 'structure', 'members' => [ 'After' => [ 'shape' => 'SectionAfterPageBreak', ], ], ], 'BookmarksConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BorderStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'BoxPlotAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'BoxPlotDimensionFieldList', ], 'Values' => [ 'shape' => 'BoxPlotMeasureFieldList', ], ], ], 'BoxPlotChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'BoxPlotFieldWells', ], 'SortConfiguration' => [ 'shape' => 'BoxPlotSortConfiguration', ], 'BoxPlotOptions' => [ 'shape' => 'BoxPlotOptions', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'BoxPlotDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'BoxPlotFieldWells' => [ 'type' => 'structure', 'members' => [ 'BoxPlotAggregatedFieldWells' => [ 'shape' => 'BoxPlotAggregatedFieldWells', ], ], ], 'BoxPlotFillStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'TRANSPARENT', ], ], 'BoxPlotMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 5, ], 'BoxPlotOptions' => [ 'type' => 'structure', 'members' => [ 'StyleOptions' => [ 'shape' => 'BoxPlotStyleOptions', ], 'OutlierVisibility' => [ 'shape' => 'Visibility', ], 'AllDataPointsVisibility' => [ 'shape' => 'Visibility', ], ], ], 'BoxPlotSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'PaginationConfiguration' => [ 'shape' => 'PaginationConfiguration', ], ], ], 'BoxPlotStyleOptions' => [ 'type' => 'structure', 'members' => [ 'FillStyle' => [ 'shape' => 'BoxPlotFillStyle', ], ], ], 'BoxPlotVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'BoxPlotChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'CIDR' => [ 'type' => 'string', 'pattern' => '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$', ], 'CalculatedColumn' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'ColumnId', 'Expression', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'ColumnId' => [ 'shape' => 'ColumnId', ], 'Expression' => [ 'shape' => 'DataSetCalculatedFieldExpression', ], ], ], 'CalculatedColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CalculatedColumn', ], 'max' => 128, 'min' => 1, ], 'CalculatedField' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'Name', 'Expression', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Name' => [ 'shape' => 'ColumnName', ], 'Expression' => [ 'shape' => 'CalculatedFieldExpression', ], ], ], 'CalculatedFieldExpression' => [ 'type' => 'string', 'max' => 32000, 'min' => 1, 'sensitive' => true, ], 'CalculatedFieldReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], 'max' => 250, ], 'CalculatedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'CalculatedField', ], 'max' => 500, ], 'CalculatedMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Expression', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Expression' => [ 'shape' => 'Expression', ], ], ], 'CancelIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'IngestionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], ], ], 'CancelIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CascadingControlConfiguration' => [ 'type' => 'structure', 'members' => [ 'SourceControls' => [ 'shape' => 'CascadingControlSourceList', ], ], ], 'CascadingControlSource' => [ 'type' => 'structure', 'members' => [ 'SourceSheetControlId' => [ 'shape' => 'String', ], 'ColumnToMatch' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'CascadingControlSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CascadingControlSource', ], 'max' => 200, ], 'CastColumnTypeOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'NewColumnType', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'NewColumnType' => [ 'shape' => 'ColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], 'Format' => [ 'shape' => 'TypeCastFormat', ], ], ], 'Catalog' => [ 'type' => 'string', 'max' => 128, ], 'CategoricalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', ], ], 'CategoricalDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], ], ], 'CategoricalMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'CategoricalAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], ], ], 'CategoryDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'CategoryValues', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], ], ], 'CategoryFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'Configuration', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Configuration' => [ 'shape' => 'CategoryFilterConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'CategoryFilterConfiguration' => [ 'type' => 'structure', 'members' => [ 'FilterListConfiguration' => [ 'shape' => 'FilterListConfiguration', ], 'CustomFilterListConfiguration' => [ 'shape' => 'CustomFilterListConfiguration', ], 'CustomFilterConfiguration' => [ 'shape' => 'CustomFilterConfiguration', ], ], ], 'CategoryFilterFunction' => [ 'type' => 'string', 'enum' => [ 'EXACT', 'CONTAINS', ], ], 'CategoryFilterMatchOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'DOES_NOT_EQUAL', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', 'ENDS_WITH', ], ], 'CategoryFilterSelectAllOptions' => [ 'type' => 'string', 'enum' => [ 'FILTER_ALL_VALUES', ], ], 'CategoryFilterType' => [ 'type' => 'string', 'enum' => [ 'CUSTOM_FILTER', 'CUSTOM_FILTER_LIST', 'FILTER_LIST', ], ], 'CategoryInnerFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'Configuration', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Configuration' => [ 'shape' => 'CategoryFilterConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'CategoryValue' => [ 'type' => 'string', 'max' => 512, ], 'CategoryValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoryValue', ], 'max' => 100000, ], 'CellValueSynonym' => [ 'type' => 'structure', 'members' => [ 'CellValue' => [ 'shape' => 'LimitedString', ], 'Synonyms' => [ 'shape' => 'StringList', ], ], ], 'CellValueSynonyms' => [ 'type' => 'list', 'member' => [ 'shape' => 'CellValueSynonym', ], ], 'ChartAxisLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'SortIconVisibility' => [ 'shape' => 'Visibility', ], 'AxisLabelOptions' => [ 'shape' => 'AxisLabelOptionsList', ], ], ], 'ClusterId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ClusterMarker' => [ 'type' => 'structure', 'members' => [ 'SimpleClusterMarker' => [ 'shape' => 'SimpleClusterMarker', ], ], ], 'ClusterMarkerConfiguration' => [ 'type' => 'structure', 'members' => [ 'ClusterMarker' => [ 'shape' => 'ClusterMarker', ], ], ], 'CollectiveConstant' => [ 'type' => 'structure', 'members' => [ 'ValueList' => [ 'shape' => 'StringList', ], ], ], 'CollectiveConstantEntry' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'Value' => [ 'shape' => 'ConstantValueString', ], ], ], 'CollectiveConstantEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectiveConstantEntry', ], 'max' => 2000, ], 'ColorFillType' => [ 'type' => 'string', 'enum' => [ 'DISCRETE', 'GRADIENT', ], ], 'ColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HexColor', ], 'max' => 100, ], 'ColorScale' => [ 'type' => 'structure', 'required' => [ 'Colors', 'ColorFillType', ], 'members' => [ 'Colors' => [ 'shape' => 'ColorScaleColorList', ], 'ColorFillType' => [ 'shape' => 'ColorFillType', ], 'NullValueColor' => [ 'shape' => 'DataColor', ], ], ], 'ColorScaleColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataColor', ], 'max' => 3, 'min' => 2, ], 'ColorsConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomColors' => [ 'shape' => 'CustomColorsList', ], ], ], 'ColumnConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'FormatConfiguration' => [ 'shape' => 'FormatConfiguration', ], 'Role' => [ 'shape' => 'ColumnRole', ], 'ColorsConfiguration' => [ 'shape' => 'ColorsConfiguration', ], ], ], 'ColumnConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnConfiguration', ], 'max' => 2000, ], 'ColumnDataRole' => [ 'type' => 'string', 'enum' => [ 'DIMENSION', 'MEASURE', ], ], 'ColumnDataSubType' => [ 'type' => 'string', 'enum' => [ 'FLOAT', 'FIXED', ], ], 'ColumnDataType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'INTEGER', 'DECIMAL', 'DATETIME', ], ], 'ColumnDescription' => [ 'type' => 'structure', 'members' => [ 'Text' => [ 'shape' => 'ColumnDescriptiveText', ], ], ], 'ColumnDescriptiveText' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'sensitive' => true, ], 'ColumnGroup' => [ 'type' => 'structure', 'members' => [ 'GeoSpatialColumnGroup' => [ 'shape' => 'GeoSpatialColumnGroup', ], ], ], 'ColumnGroupColumnSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], ], 'ColumnGroupColumnSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroupColumnSchema', ], 'max' => 500, ], 'ColumnGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroup', ], 'max' => 8, 'min' => 1, ], 'ColumnGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ColumnGroupSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ColumnGroupColumnSchemaList' => [ 'shape' => 'ColumnGroupColumnSchemaList', ], ], ], 'ColumnGroupSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnGroupSchema', ], 'max' => 500, ], 'ColumnHierarchy' => [ 'type' => 'structure', 'members' => [ 'ExplicitHierarchy' => [ 'shape' => 'ExplicitHierarchy', ], 'DateTimeHierarchy' => [ 'shape' => 'DateTimeHierarchy', ], 'PredefinedHierarchy' => [ 'shape' => 'PredefinedHierarchy', ], ], ], 'ColumnHierarchyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnHierarchy', ], 'max' => 2, ], 'ColumnId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ColumnIdentifier' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'ColumnName', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'ColumnName' => [ 'shape' => 'ColumnName', ], ], ], 'ColumnLevelPermissionRule' => [ 'type' => 'structure', 'members' => [ 'Principals' => [ 'shape' => 'PrincipalList', ], 'ColumnNames' => [ 'shape' => 'ColumnNameList', ], ], ], 'ColumnLevelPermissionRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnLevelPermissionRule', ], 'min' => 1, ], 'ColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnName', ], 'max' => 16, 'min' => 1, ], 'ColumnName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ColumnNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'ColumnOrderingType' => [ 'type' => 'string', 'enum' => [ 'GREATER_IS_BETTER', 'LESSER_IS_BETTER', 'SPECIFIED', ], ], 'ColumnRole' => [ 'type' => 'string', 'enum' => [ 'DIMENSION', 'MEASURE', ], ], 'ColumnSchema' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'GeographicRole' => [ 'shape' => 'String', ], ], ], 'ColumnSchemaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnSchema', ], 'max' => 500, ], 'ColumnSort' => [ 'type' => 'structure', 'required' => [ 'SortBy', 'Direction', ], 'members' => [ 'SortBy' => [ 'shape' => 'ColumnIdentifier', ], 'Direction' => [ 'shape' => 'SortDirection', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], ], ], 'ColumnTag' => [ 'type' => 'structure', 'members' => [ 'ColumnGeographicRole' => [ 'shape' => 'GeoSpatialDataRole', ], 'ColumnDescription' => [ 'shape' => 'ColumnDescription', ], ], ], 'ColumnTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnTag', ], 'max' => 16, 'min' => 1, ], 'ColumnTagName' => [ 'type' => 'string', 'enum' => [ 'COLUMN_GEOGRAPHIC_ROLE', 'COLUMN_DESCRIPTION', ], ], 'ColumnTagNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnTagName', ], ], 'ColumnTooltipItem' => [ 'type' => 'structure', 'required' => [ 'Column', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Label' => [ 'shape' => 'String', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'Aggregation' => [ 'shape' => 'AggregationFunction', ], 'TooltipTarget' => [ 'shape' => 'TooltipTarget', ], ], ], 'ComboChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'BarValues' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'LineValues' => [ 'shape' => 'MeasureFieldList', ], ], ], 'ComboChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'ComboChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'ComboChartSortConfiguration', ], 'BarsArrangement' => [ 'shape' => 'BarsArrangement', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SecondaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'SecondaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SingleAxisOptions' => [ 'shape' => 'SingleAxisOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'BarDataLabels' => [ 'shape' => 'DataLabelOptions', ], 'LineDataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'ComboChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'ComboChartAggregatedFieldWells' => [ 'shape' => 'ComboChartAggregatedFieldWells', ], ], ], 'ComboChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'ComboChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'ComboChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'ComparativeOrder' => [ 'type' => 'structure', 'members' => [ 'UseOrdering' => [ 'shape' => 'ColumnOrderingType', ], 'SpecifedOrder' => [ 'shape' => 'StringList', ], 'TreatUndefinedSpecifiedValues' => [ 'shape' => 'UndefinedSpecifiedValueType', ], ], ], 'ComparisonConfiguration' => [ 'type' => 'structure', 'members' => [ 'ComparisonMethod' => [ 'shape' => 'ComparisonMethod', ], 'ComparisonFormat' => [ 'shape' => 'ComparisonFormatConfiguration', ], ], ], 'ComparisonFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NumberDisplayFormatConfiguration' => [ 'shape' => 'NumberDisplayFormatConfiguration', ], 'PercentageDisplayFormatConfiguration' => [ 'shape' => 'PercentageDisplayFormatConfiguration', ], ], ], 'ComparisonMethod' => [ 'type' => 'string', 'enum' => [ 'DIFFERENCE', 'PERCENT_DIFFERENCE', 'PERCENT', ], ], 'ComparisonMethodType' => [ 'type' => 'string', 'enum' => [ 'DIFF', 'PERC_DIFF', 'DIFF_AS_PERC', 'POP_CURRENT_DIFF_AS_PERC', 'POP_CURRENT_DIFF', 'POP_OVERTIME_DIFF_AS_PERC', 'POP_OVERTIME_DIFF', 'PERCENT_OF_TOTAL', 'RUNNING_SUM', 'MOVING_AVERAGE', ], ], 'Computation' => [ 'type' => 'structure', 'members' => [ 'TopBottomRanked' => [ 'shape' => 'TopBottomRankedComputation', ], 'TopBottomMovers' => [ 'shape' => 'TopBottomMoversComputation', ], 'TotalAggregation' => [ 'shape' => 'TotalAggregationComputation', ], 'MaximumMinimum' => [ 'shape' => 'MaximumMinimumComputation', ], 'MetricComparison' => [ 'shape' => 'MetricComparisonComputation', ], 'PeriodOverPeriod' => [ 'shape' => 'PeriodOverPeriodComputation', ], 'PeriodToDate' => [ 'shape' => 'PeriodToDateComputation', ], 'GrowthRate' => [ 'shape' => 'GrowthRateComputation', ], 'UniqueValues' => [ 'shape' => 'UniqueValuesComputation', ], 'Forecast' => [ 'shape' => 'ForecastComputation', ], ], ], 'ComputationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Computation', ], 'max' => 100, ], 'ConcurrentUpdatingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'ConditionalFormattingColor' => [ 'type' => 'structure', 'members' => [ 'Solid' => [ 'shape' => 'ConditionalFormattingSolidColor', ], 'Gradient' => [ 'shape' => 'ConditionalFormattingGradientColor', ], ], ], 'ConditionalFormattingCustomIconCondition' => [ 'type' => 'structure', 'required' => [ 'Expression', 'IconOptions', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'IconOptions' => [ 'shape' => 'ConditionalFormattingCustomIconOptions', ], 'Color' => [ 'shape' => 'HexColor', ], 'DisplayConfiguration' => [ 'shape' => 'ConditionalFormattingIconDisplayConfiguration', ], ], ], 'ConditionalFormattingCustomIconOptions' => [ 'type' => 'structure', 'members' => [ 'Icon' => [ 'shape' => 'Icon', ], 'UnicodeIcon' => [ 'shape' => 'UnicodeIcon', ], ], ], 'ConditionalFormattingGradientColor' => [ 'type' => 'structure', 'required' => [ 'Expression', 'Color', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Color' => [ 'shape' => 'GradientColor', ], ], ], 'ConditionalFormattingIcon' => [ 'type' => 'structure', 'members' => [ 'IconSet' => [ 'shape' => 'ConditionalFormattingIconSet', ], 'CustomCondition' => [ 'shape' => 'ConditionalFormattingCustomIconCondition', ], ], ], 'ConditionalFormattingIconDisplayConfiguration' => [ 'type' => 'structure', 'members' => [ 'IconDisplayOption' => [ 'shape' => 'ConditionalFormattingIconDisplayOption', ], ], ], 'ConditionalFormattingIconDisplayOption' => [ 'type' => 'string', 'enum' => [ 'ICON_ONLY', ], ], 'ConditionalFormattingIconSet' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'IconSetType' => [ 'shape' => 'ConditionalFormattingIconSetType', ], ], ], 'ConditionalFormattingIconSetType' => [ 'type' => 'string', 'enum' => [ 'PLUS_MINUS', 'CHECK_X', 'THREE_COLOR_ARROW', 'THREE_GRAY_ARROW', 'CARET_UP_MINUS_DOWN', 'THREE_SHAPE', 'THREE_CIRCLE', 'FLAGS', 'BARS', 'FOUR_COLOR_ARROW', 'FOUR_GRAY_ARROW', ], ], 'ConditionalFormattingSolidColor' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConstantType' => [ 'type' => 'string', 'enum' => [ 'SINGULAR', 'RANGE', 'COLLECTIVE', ], ], 'ConstantValueString' => [ 'type' => 'string', 'max' => 1024, ], 'ContextMenuOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ContributionAnalysisDefault' => [ 'type' => 'structure', 'required' => [ 'MeasureFieldId', 'ContributorDimensions', ], 'members' => [ 'MeasureFieldId' => [ 'shape' => 'FieldId', ], 'ContributorDimensions' => [ 'shape' => 'ContributorDimensionList', ], ], ], 'ContributionAnalysisDefaultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContributionAnalysisDefault', ], 'max' => 200, 'min' => 1, ], 'ContributionAnalysisDirection' => [ 'type' => 'string', 'enum' => [ 'INCREASE', 'DECREASE', 'NEUTRAL', ], ], 'ContributionAnalysisFactor' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], ], ], 'ContributionAnalysisFactorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContributionAnalysisFactor', ], 'max' => 50, ], 'ContributionAnalysisSortType' => [ 'type' => 'string', 'enum' => [ 'ABSOLUTE_DIFFERENCE', 'CONTRIBUTION_PERCENTAGE', 'DEVIATION_FROM_EXPECTED', 'PERCENTAGE_DIFFERENCE', ], ], 'ContributionAnalysisTimeRanges' => [ 'type' => 'structure', 'members' => [ 'StartRange' => [ 'shape' => 'TopicIRFilterOption', ], 'EndRange' => [ 'shape' => 'TopicIRFilterOption', ], ], ], 'ContributorDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 4, 'min' => 1, ], 'CopySourceArn' => [ 'type' => 'string', 'pattern' => '^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+', ], 'CreateAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AccountCustomization', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AuthenticationMethod', 'AwsAccountId', 'AccountName', 'NotificationEmail', ], 'members' => [ 'Edition' => [ 'shape' => 'Edition', ], 'AuthenticationMethod' => [ 'shape' => 'AuthenticationMethodOption', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AccountName' => [ 'shape' => 'AccountName', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'ActiveDirectoryName' => [ 'shape' => 'String', ], 'Realm' => [ 'shape' => 'String', ], 'DirectoryId' => [ 'shape' => 'String', ], 'AdminGroup' => [ 'shape' => 'GroupsList', ], 'AuthorGroup' => [ 'shape' => 'GroupsList', ], 'ReaderGroup' => [ 'shape' => 'GroupsList', ], 'AdminProGroup' => [ 'shape' => 'GroupsList', ], 'AuthorProGroup' => [ 'shape' => 'GroupsList', ], 'ReaderProGroup' => [ 'shape' => 'GroupsList', ], 'FirstName' => [ 'shape' => 'String', ], 'LastName' => [ 'shape' => 'String', ], 'EmailAddress' => [ 'shape' => 'String', ], 'ContactNumber' => [ 'shape' => 'String', ], 'IAMIdentityCenterInstanceArn' => [ 'shape' => 'String', ], ], ], 'CreateAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'SignupResponse' => [ 'shape' => 'SignupResponse', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'AnalysisSourceEntity', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateColumnsOperation' => [ 'type' => 'structure', 'required' => [ 'Columns', ], 'members' => [ 'Columns' => [ 'shape' => 'CalculatedColumnList', ], ], ], 'CreateDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'DashboardSourceEntity', ], 'Tags' => [ 'shape' => 'TagList', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'CreateDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'Name', 'PhysicalTableMap', 'ImportMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'IngestionArn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', 'Name', 'Type', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'Credentials' => [ 'shape' => 'DataSourceCredentials', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'FolderArns' => [ 'shape' => 'FolderArnList', ], ], ], 'CreateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateFolderMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'MemberId', 'MemberType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'MemberId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'MemberId', ], 'MemberType' => [ 'shape' => 'MemberType', 'location' => 'uri', 'locationName' => 'MemberType', ], ], ], 'CreateFolderMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'FolderMember' => [ 'shape' => 'FolderMember', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'ParentFolderArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'CreateFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMember' => [ 'shape' => 'GroupMember', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'AssignmentStatus', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'CreateIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentId' => [ 'shape' => 'String', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'IngestionId', 'AwsAccountId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'IngestionType' => [ 'shape' => 'IngestionType', ], ], ], 'CreateIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'IngestionStatus' => [ 'shape' => 'IngestionStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'IdentityStore', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'Namespace', ], 'CapacityRegion' => [ 'shape' => 'String', ], 'CreationStatus' => [ 'shape' => 'NamespaceStatus', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'Schedule', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Schedule' => [ 'shape' => 'RefreshSchedule', ], ], ], 'CreateRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'CreateRoleMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'AwsAccountId', 'Namespace', 'Role', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], ], ], 'CreateRoleMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', 'TemplateVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'CreateTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'SourceEntity' => [ 'shape' => 'TemplateSourceEntity', ], 'Tags' => [ 'shape' => 'TagList', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'CreateTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', 'ThemeVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'CreateThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'Name', 'BaseThemeId', 'Configuration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'Name' => [ 'shape' => 'ThemeName', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetArn', 'RefreshSchedule', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'String', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'CreateTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'CreateTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Topic', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'RefreshArn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CreateTopicReviewedAnswer' => [ 'type' => 'structure', 'required' => [ 'AnswerId', 'DatasetArn', 'Question', ], 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Question' => [ 'shape' => 'LimitedString', ], 'Mir' => [ 'shape' => 'TopicIR', ], 'PrimaryVisual' => [ 'shape' => 'TopicVisual', ], 'Template' => [ 'shape' => 'TopicTemplate', ], ], ], 'CreateTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'CreateTopicReviewedAnswer', ], 'max' => 100, 'min' => 0, ], 'CreateVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', 'Name', 'SubnetIds', 'SecurityGroupIds', 'RoleArn', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdRestricted', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdRestricted', ], 'CreationStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'CredentialPair' => [ 'type' => 'structure', 'required' => [ 'Username', 'Password', ], 'members' => [ 'Username' => [ 'shape' => 'DbUsername', ], 'Password' => [ 'shape' => 'Password', ], 'AlternateDataSourceParameters' => [ 'shape' => 'DataSourceParametersList', ], ], ], 'CrossDatasetTypes' => [ 'type' => 'string', 'enum' => [ 'ALL_DATASETS', 'SINGLE_DATASET', ], ], 'CurrencyCode' => [ 'type' => 'string', 'pattern' => '[A-Z]{3}', ], 'CurrencyDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'Symbol' => [ 'shape' => 'CurrencyCode', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NumberScale' => [ 'shape' => 'NumberScale', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'CustomActionColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, ], 'CustomActionFilterOperation' => [ 'type' => 'structure', 'required' => [ 'SelectedFieldsConfiguration', 'TargetVisualsConfiguration', ], 'members' => [ 'SelectedFieldsConfiguration' => [ 'shape' => 'FilterOperationSelectedFieldsConfiguration', ], 'TargetVisualsConfiguration' => [ 'shape' => 'FilterOperationTargetVisualsConfiguration', ], ], ], 'CustomActionNavigationOperation' => [ 'type' => 'structure', 'members' => [ 'LocalNavigationConfiguration' => [ 'shape' => 'LocalNavigationConfiguration', ], ], ], 'CustomActionSetParametersOperation' => [ 'type' => 'structure', 'required' => [ 'ParameterValueConfigurations', ], 'members' => [ 'ParameterValueConfigurations' => [ 'shape' => 'SetParameterValueConfigurationList', ], ], ], 'CustomActionURLOperation' => [ 'type' => 'structure', 'required' => [ 'URLTemplate', 'URLTarget', ], 'members' => [ 'URLTemplate' => [ 'shape' => 'URLOperationTemplate', ], 'URLTarget' => [ 'shape' => 'URLTargetConfiguration', ], ], ], 'CustomColor' => [ 'type' => 'structure', 'required' => [ 'Color', ], 'members' => [ 'FieldValue' => [ 'shape' => 'FieldValue', ], 'Color' => [ 'shape' => 'HexColor', ], 'SpecialValue' => [ 'shape' => 'SpecialValue', ], ], ], 'CustomColorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomColor', ], 'max' => 50, ], 'CustomContentConfiguration' => [ 'type' => 'structure', 'members' => [ 'ContentUrl' => [ 'shape' => 'URLOperationTemplate', ], 'ContentType' => [ 'shape' => 'CustomContentType', ], 'ImageScaling' => [ 'shape' => 'CustomContentImageScalingConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'CustomContentImageScalingConfiguration' => [ 'type' => 'string', 'enum' => [ 'FIT_TO_HEIGHT', 'FIT_TO_WIDTH', 'DO_NOT_SCALE', 'SCALE_TO_VISUAL', ], ], 'CustomContentType' => [ 'type' => 'string', 'enum' => [ 'IMAGE', 'OTHER_EMBEDDED_CONTENT', ], ], 'CustomContentVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'CustomContentConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], ], ], 'CustomFilterConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', 'NullOption', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValue' => [ 'shape' => 'CategoryValue', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'CustomFilterListConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', 'NullOption', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'CustomLabel' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'CustomNarrativeOptions' => [ 'type' => 'structure', 'required' => [ 'Narrative', ], 'members' => [ 'Narrative' => [ 'shape' => 'NarrativeString', ], ], ], 'CustomParameterValues' => [ 'type' => 'structure', 'members' => [ 'StringValues' => [ 'shape' => 'StringDefaultValueList', ], 'IntegerValues' => [ 'shape' => 'IntegerDefaultValueList', ], 'DecimalValues' => [ 'shape' => 'DecimalDefaultValueList', ], 'DateTimeValues' => [ 'shape' => 'DateTimeDefaultValueList', ], ], ], 'CustomSql' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'Name', 'SqlQuery', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'CustomSqlName', ], 'SqlQuery' => [ 'shape' => 'SqlQuery', ], 'Columns' => [ 'shape' => 'InputColumnList', ], ], ], 'CustomSqlName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CustomValuesConfiguration' => [ 'type' => 'structure', 'required' => [ 'CustomValues', ], 'members' => [ 'IncludeNullValue' => [ 'shape' => 'BooleanObject', ], 'CustomValues' => [ 'shape' => 'CustomParameterValues', ], ], ], 'CustomerManagedKeyUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Dashboard' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'DashboardName', ], 'Version' => [ 'shape' => 'DashboardVersion', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastPublishedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'DashboardBehavior' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'DashboardError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'DashboardErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'DashboardErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardError', ], 'min' => 1, ], 'DashboardErrorType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'PARAMETER_VALUE_INCOMPATIBLE', 'PARAMETER_TYPE_INVALID', 'PARAMETER_NOT_FOUND', 'COLUMN_TYPE_MISMATCH', 'COLUMN_GEOGRAPHIC_ROLE_MISMATCH', 'COLUMN_REPLACEMENT_MISSING', ], ], 'DashboardFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_USER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DASHBOARD_NAME', ], ], 'DashboardName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'DashboardPublishOptions' => [ 'type' => 'structure', 'members' => [ 'AdHocFilteringOption' => [ 'shape' => 'AdHocFilteringOption', ], 'ExportToCSVOption' => [ 'shape' => 'ExportToCSVOption', ], 'SheetControlsOption' => [ 'shape' => 'SheetControlsOption', ], 'VisualPublishOptions' => [ 'shape' => 'DashboardVisualPublishOptions', 'deprecated' => true, 'deprecatedMessage' => 'VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields.', ], 'SheetLayoutElementMaximizationOption' => [ 'shape' => 'SheetLayoutElementMaximizationOption', ], 'VisualMenuOption' => [ 'shape' => 'VisualMenuOption', ], 'VisualAxisSortOption' => [ 'shape' => 'VisualAxisSortOption', ], 'ExportWithHiddenFieldsOption' => [ 'shape' => 'ExportWithHiddenFieldsOption', ], 'DataPointDrillUpDownOption' => [ 'shape' => 'DataPointDrillUpDownOption', ], 'DataPointMenuLabelOption' => [ 'shape' => 'DataPointMenuLabelOption', ], 'DataPointTooltipOption' => [ 'shape' => 'DataPointTooltipOption', ], ], ], 'DashboardSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DashboardFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DashboardSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DashboardSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceTemplate' => [ 'shape' => 'DashboardSourceTemplate', ], ], ], 'DashboardSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'DataSetReferences', 'Arn', ], 'members' => [ 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DashboardSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'PublishedVersionNumber' => [ 'shape' => 'VersionNumber', ], 'LastPublishedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DashboardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardSummary', ], 'max' => 100, ], 'DashboardUIState' => [ 'type' => 'string', 'enum' => [ 'EXPANDED', 'COLLAPSED', ], ], 'DashboardVersion' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Errors' => [ 'shape' => 'DashboardErrorList', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Arn' => [ 'shape' => 'Arn', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'DataSetArns' => [ 'shape' => 'DataSetArnsList', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'DashboardVersionDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifierDeclarations', ], 'members' => [ 'DataSetIdentifierDeclarations' => [ 'shape' => 'DataSetIdentifierDeclarationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], ], ], 'DashboardVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], ], ], 'DashboardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DashboardVersionSummary', ], 'max' => 100, ], 'DashboardVisualId' => [ 'type' => 'structure', 'required' => [ 'DashboardId', 'SheetId', 'VisualId', ], 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DashboardVisualPublishOptions' => [ 'type' => 'structure', 'members' => [ 'ExportHiddenFieldsOption' => [ 'shape' => 'ExportHiddenFieldsOption', ], ], ], 'DataAggregation' => [ 'type' => 'structure', 'members' => [ 'DatasetRowDateGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'DefaultDateColumnName' => [ 'shape' => 'LimitedString', ], ], ], 'DataBarsOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'PositiveColor' => [ 'shape' => 'HexColor', ], 'NegativeColor' => [ 'shape' => 'HexColor', ], ], ], 'DataColor' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], 'DataValue' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'DataColorPalette' => [ 'type' => 'structure', 'members' => [ 'Colors' => [ 'shape' => 'ColorList', ], 'MinMaxGradient' => [ 'shape' => 'ColorList', ], 'EmptyFillColor' => [ 'shape' => 'HexColor', ], ], ], 'DataFieldSeriesItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'AxisBinding', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'SensitiveString', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'Settings' => [ 'shape' => 'LineChartSeriesSettings', ], ], ], 'DataLabelContent' => [ 'type' => 'string', 'enum' => [ 'VALUE', 'PERCENT', 'VALUE_AND_PERCENT', ], ], 'DataLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CategoryLabelVisibility' => [ 'shape' => 'Visibility', ], 'MeasureLabelVisibility' => [ 'shape' => 'Visibility', ], 'DataLabelTypes' => [ 'shape' => 'DataLabelTypes', ], 'Position' => [ 'shape' => 'DataLabelPosition', ], 'LabelContent' => [ 'shape' => 'DataLabelContent', ], 'LabelFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'LabelColor' => [ 'shape' => 'HexColor', ], 'Overlap' => [ 'shape' => 'DataLabelOverlap', ], 'TotalsVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DataLabelOverlap' => [ 'type' => 'string', 'enum' => [ 'DISABLE_OVERLAP', 'ENABLE_OVERLAP', ], ], 'DataLabelPosition' => [ 'type' => 'string', 'enum' => [ 'INSIDE', 'OUTSIDE', 'LEFT', 'TOP', 'BOTTOM', 'RIGHT', ], ], 'DataLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldLabelType' => [ 'shape' => 'FieldLabelType', ], 'DataPathLabelType' => [ 'shape' => 'DataPathLabelType', ], 'RangeEndsLabelType' => [ 'shape' => 'RangeEndsLabelType', ], 'MinimumLabelType' => [ 'shape' => 'MinimumLabelType', ], 'MaximumLabelType' => [ 'shape' => 'MaximumLabelType', ], ], ], 'DataLabelTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataLabelType', ], 'max' => 100, ], 'DataPathColor' => [ 'type' => 'structure', 'required' => [ 'Element', 'Color', ], 'members' => [ 'Element' => [ 'shape' => 'DataPathValue', ], 'Color' => [ 'shape' => 'HexColor', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'DataPathColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataPathColor', ], 'max' => 5000, ], 'DataPathLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'FieldValue', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'DataPathSort' => [ 'type' => 'structure', 'required' => [ 'Direction', 'SortPaths', ], 'members' => [ 'Direction' => [ 'shape' => 'SortDirection', ], 'SortPaths' => [ 'shape' => 'DataPathValueList', ], ], ], 'DataPathType' => [ 'type' => 'structure', 'members' => [ 'PivotTableDataPathType' => [ 'shape' => 'PivotTableDataPathType', ], ], ], 'DataPathValue' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'FieldValue' => [ 'shape' => 'FieldValue', ], 'DataPathType' => [ 'shape' => 'DataPathType', ], ], ], 'DataPathValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataPathValue', ], 'max' => 20, ], 'DataPointDrillUpDownOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataPointMenuLabelOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataPointTooltipOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'DataSet' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'OutputColumns' => [ 'shape' => 'OutputColumnList', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ConsumedSpiceCapacityInBytes' => [ 'shape' => 'Long', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], ], ], 'DataSetArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 100, ], 'DataSetCalculatedFieldExpression' => [ 'type' => 'string', 'max' => 250000, 'min' => 1, 'sensitive' => true, ], 'DataSetConfiguration' => [ 'type' => 'structure', 'members' => [ 'Placeholder' => [ 'shape' => 'String', ], 'DataSetSchema' => [ 'shape' => 'DataSetSchema', ], 'ColumnGroupSchemaList' => [ 'shape' => 'ColumnGroupSchemaList', ], ], ], 'DataSetConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetConfiguration', ], 'max' => 30, ], 'DataSetFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DATASET_NAME', ], ], 'DataSetIdentifier' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'DataSetIdentifierDeclaration' => [ 'type' => 'structure', 'required' => [ 'Identifier', 'DataSetArn', ], 'members' => [ 'Identifier' => [ 'shape' => 'DataSetIdentifier', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'DataSetIdentifierDeclarationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetIdentifierDeclaration', ], 'max' => 50, 'min' => 1, ], 'DataSetImportMode' => [ 'type' => 'string', 'enum' => [ 'SPICE', 'DIRECT_QUERY', ], ], 'DataSetName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DataSetReference' => [ 'type' => 'structure', 'required' => [ 'DataSetPlaceholder', 'DataSetArn', ], 'members' => [ 'DataSetPlaceholder' => [ 'shape' => 'NonEmptyString', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'DataSetReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetReference', ], 'min' => 1, ], 'DataSetRefreshProperties' => [ 'type' => 'structure', 'required' => [ 'RefreshConfiguration', ], 'members' => [ 'RefreshConfiguration' => [ 'shape' => 'RefreshConfiguration', ], ], ], 'DataSetRegion' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'DataSetSchema' => [ 'type' => 'structure', 'members' => [ 'ColumnSchemaList' => [ 'shape' => 'ColumnSchemaList', ], ], ], 'DataSetSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DataSetFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DataSetSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DataSetSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfigurationApplied' => [ 'shape' => 'Boolean', ], 'ColumnLevelPermissionRulesApplied' => [ 'shape' => 'Boolean', ], ], ], 'DataSetSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetSummary', ], ], 'DataSetUsageConfiguration' => [ 'type' => 'structure', 'members' => [ 'DisableUseAsDirectQuerySource' => [ 'shape' => 'Boolean', ], 'DisableUseAsImportedSource' => [ 'shape' => 'Boolean', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'AlternateDataSourceParameters' => [ 'shape' => 'DataSourceParametersList', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], 'ErrorInfo' => [ 'shape' => 'DataSourceErrorInfo', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'DataSourceCredentials' => [ 'type' => 'structure', 'members' => [ 'CredentialPair' => [ 'shape' => 'CredentialPair', ], 'CopySourceArn' => [ 'shape' => 'CopySourceArn', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], 'sensitive' => true, ], 'DataSourceErrorInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'DataSourceErrorInfoType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DataSourceErrorInfoType' => [ 'type' => 'string', 'enum' => [ 'ACCESS_DENIED', 'COPY_SOURCE_NOT_FOUND', 'TIMEOUT', 'ENGINE_VERSION_NOT_SUPPORTED', 'UNKNOWN_HOST', 'GENERIC_SQL_FAILURE', 'CONFLICT', 'UNKNOWN', ], ], 'DataSourceFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DATASOURCE_NAME', ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSource', ], ], 'DataSourceParameters' => [ 'type' => 'structure', 'members' => [ 'AmazonElasticsearchParameters' => [ 'shape' => 'AmazonElasticsearchParameters', ], 'AthenaParameters' => [ 'shape' => 'AthenaParameters', ], 'AuroraParameters' => [ 'shape' => 'AuroraParameters', ], 'AuroraPostgreSqlParameters' => [ 'shape' => 'AuroraPostgreSqlParameters', ], 'AwsIotAnalyticsParameters' => [ 'shape' => 'AwsIotAnalyticsParameters', ], 'JiraParameters' => [ 'shape' => 'JiraParameters', ], 'MariaDbParameters' => [ 'shape' => 'MariaDbParameters', ], 'MySqlParameters' => [ 'shape' => 'MySqlParameters', ], 'OracleParameters' => [ 'shape' => 'OracleParameters', ], 'PostgreSqlParameters' => [ 'shape' => 'PostgreSqlParameters', ], 'PrestoParameters' => [ 'shape' => 'PrestoParameters', ], 'RdsParameters' => [ 'shape' => 'RdsParameters', ], 'RedshiftParameters' => [ 'shape' => 'RedshiftParameters', ], 'S3Parameters' => [ 'shape' => 'S3Parameters', ], 'ServiceNowParameters' => [ 'shape' => 'ServiceNowParameters', ], 'SnowflakeParameters' => [ 'shape' => 'SnowflakeParameters', ], 'SparkParameters' => [ 'shape' => 'SparkParameters', ], 'SqlServerParameters' => [ 'shape' => 'SqlServerParameters', ], 'TeradataParameters' => [ 'shape' => 'TeradataParameters', ], 'TwitterParameters' => [ 'shape' => 'TwitterParameters', ], 'AmazonOpenSearchParameters' => [ 'shape' => 'AmazonOpenSearchParameters', ], 'ExasolParameters' => [ 'shape' => 'ExasolParameters', ], 'DatabricksParameters' => [ 'shape' => 'DatabricksParameters', ], 'StarburstParameters' => [ 'shape' => 'StarburstParameters', ], 'TrinoParameters' => [ 'shape' => 'TrinoParameters', ], 'BigQueryParameters' => [ 'shape' => 'BigQueryParameters', ], ], ], 'DataSourceParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceParameters', ], 'max' => 50, 'min' => 1, ], 'DataSourceSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'DataSourceFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DataSourceSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSearchFilter', ], 'max' => 1, 'min' => 1, ], 'DataSourceSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'DataSourceType', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DataSourceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceSummary', ], ], 'DataSourceType' => [ 'type' => 'string', 'enum' => [ 'ADOBE_ANALYTICS', 'AMAZON_ELASTICSEARCH', 'ATHENA', 'AURORA', 'AURORA_POSTGRESQL', 'AWS_IOT_ANALYTICS', 'GITHUB', 'JIRA', 'MARIADB', 'MYSQL', 'ORACLE', 'POSTGRESQL', 'PRESTO', 'REDSHIFT', 'S3', 'SALESFORCE', 'SERVICENOW', 'SNOWFLAKE', 'SPARK', 'SQLSERVER', 'TERADATA', 'TWITTER', 'TIMESTREAM', 'AMAZON_OPENSEARCH', 'EXASOL', 'DATABRICKS', 'STARBURST', 'TRINO', 'BIGQUERY', ], ], 'Database' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DatabaseGroup' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DatabaseGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatabaseGroup', ], 'max' => 50, 'min' => 1, ], 'DatabaseUser' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DatabricksParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'SqlEndpointPath', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'SqlEndpointPath' => [ 'shape' => 'SqlEndpointPath', ], ], ], 'DatasetMetadata' => [ 'type' => 'structure', 'required' => [ 'DatasetArn', ], 'members' => [ 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'LimitedString', ], 'DatasetDescription' => [ 'shape' => 'LimitedString', ], 'DataAggregation' => [ 'shape' => 'DataAggregation', ], 'Filters' => [ 'shape' => 'TopicFilters', ], 'Columns' => [ 'shape' => 'TopicColumns', ], 'CalculatedFields' => [ 'shape' => 'TopicCalculatedFields', ], 'NamedEntities' => [ 'shape' => 'TopicNamedEntities', ], ], ], 'DatasetParameter' => [ 'type' => 'structure', 'members' => [ 'StringDatasetParameter' => [ 'shape' => 'StringDatasetParameter', ], 'DecimalDatasetParameter' => [ 'shape' => 'DecimalDatasetParameter', ], 'IntegerDatasetParameter' => [ 'shape' => 'IntegerDatasetParameter', ], 'DateTimeDatasetParameter' => [ 'shape' => 'DateTimeDatasetParameter', ], ], ], 'DatasetParameterId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'DatasetParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetParameter', ], 'max' => 32, 'min' => 1, ], 'DatasetParameterName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'DatasetParameterValueType' => [ 'type' => 'string', 'enum' => [ 'MULTI_VALUED', 'SINGLE_VALUED', ], ], 'Datasets' => [ 'type' => 'list', 'member' => [ 'shape' => 'DatasetMetadata', ], ], 'DateAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'COUNT', 'DISTINCT_COUNT', 'MIN', 'MAX', ], ], 'DateAxisOptions' => [ 'type' => 'structure', 'members' => [ 'MissingDateVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DateDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'DateGranularity' => [ 'shape' => 'TimeGranularity', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'DateMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'DateAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'DateTimeDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'DefaultValues' => [ 'shape' => 'DateTimeDatasetParameterDefaultValues', ], ], ], 'DateTimeDatasetParameterDefaultValue' => [ 'type' => 'timestamp', ], 'DateTimeDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'DateTimeDatasetParameterValueList', ], ], ], 'DateTimeDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DateTimeDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'DateTimeDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveTimestamp', ], 'max' => 50000, ], 'DateTimeDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'DateTimeDefaultValueList', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], ], ], 'DateTimeFormat' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'DateTimeFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], 'NumericFormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'DateTimeHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'DateTimeParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveTimestampList', ], ], ], 'DateTimeParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'DateTimeDefaultValues', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'ValueWhenUnset' => [ 'shape' => 'DateTimeValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'DateTimeParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DateTimeParameter', ], 'max' => 100, ], 'DateTimePickerControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], 'HelperTextVisibility' => [ 'shape' => 'Visibility', ], 'DateIconVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DateTimeValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveTimestamp', ], ], ], 'DayOfMonth' => [ 'type' => 'string', 'max' => 17, 'min' => 1, 'pattern' => '^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$', ], 'DayOfTheWeek' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'DayOfWeek' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'DbUsername' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DecimalDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'DecimalDatasetParameterDefaultValues', ], ], ], 'DecimalDatasetParameterDefaultValue' => [ 'type' => 'double', ], 'DecimalDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'DecimalDatasetParameterValueList', ], ], ], 'DecimalDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DecimalDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'DecimalDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveDoubleObject', ], 'max' => 50000, ], 'DecimalDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'DecimalDefaultValueList', ], ], ], 'DecimalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveDoubleList', ], ], ], 'DecimalParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'DecimalDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'DecimalValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'DecimalParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DecimalParameter', ], 'max' => 100, ], 'DecimalPlaces' => [ 'type' => 'long', 'max' => 20, 'min' => 0, ], 'DecimalPlacesConfiguration' => [ 'type' => 'structure', 'required' => [ 'DecimalPlaces', ], 'members' => [ 'DecimalPlaces' => [ 'shape' => 'DecimalPlaces', ], ], ], 'DecimalValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveDouble', 'box' => true, ], ], ], 'DefaultAggregation' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MAX', 'MIN', 'COUNT', 'DISTINCT_COUNT', 'AVERAGE', 'MEDIAN', 'STDEV', 'STDEVP', 'VAR', 'VARP', ], ], 'DefaultDateTimePickerControlOptions' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'SheetControlDateTimePickerType', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], ], ], 'DefaultFilterControlConfiguration' => [ 'type' => 'structure', 'required' => [ 'Title', 'ControlOptions', ], 'members' => [ 'Title' => [ 'shape' => 'SheetControlTitle', ], 'ControlOptions' => [ 'shape' => 'DefaultFilterControlOptions', ], ], ], 'DefaultFilterControlOptions' => [ 'type' => 'structure', 'members' => [ 'DefaultDateTimePickerOptions' => [ 'shape' => 'DefaultDateTimePickerControlOptions', ], 'DefaultListOptions' => [ 'shape' => 'DefaultFilterListControlOptions', ], 'DefaultDropdownOptions' => [ 'shape' => 'DefaultFilterDropDownControlOptions', ], 'DefaultTextFieldOptions' => [ 'shape' => 'DefaultTextFieldControlOptions', ], 'DefaultTextAreaOptions' => [ 'shape' => 'DefaultTextAreaControlOptions', ], 'DefaultSliderOptions' => [ 'shape' => 'DefaultSliderControlOptions', ], 'DefaultRelativeDateTimeOptions' => [ 'shape' => 'DefaultRelativeDateTimeControlOptions', ], ], ], 'DefaultFilterDropDownControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], ], ], 'DefaultFilterListControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], ], ], 'DefaultFormatting' => [ 'type' => 'structure', 'members' => [ 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], ], ], 'DefaultFreeFormLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutCanvasSizeOptions', ], ], ], 'DefaultGridLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'GridLayoutCanvasSizeOptions', ], ], ], 'DefaultInteractiveLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'Grid' => [ 'shape' => 'DefaultGridLayoutConfiguration', ], 'FreeForm' => [ 'shape' => 'DefaultFreeFormLayoutConfiguration', ], ], ], 'DefaultNewSheetConfiguration' => [ 'type' => 'structure', 'members' => [ 'InteractiveLayoutConfiguration' => [ 'shape' => 'DefaultInteractiveLayoutConfiguration', ], 'PaginatedLayoutConfiguration' => [ 'shape' => 'DefaultPaginatedLayoutConfiguration', ], 'SheetContentType' => [ 'shape' => 'SheetContentType', ], ], ], 'DefaultPaginatedLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'SectionBased' => [ 'shape' => 'DefaultSectionBasedLayoutConfiguration', ], ], ], 'DefaultRelativeDateTimeControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'RelativeDateTimeControlDisplayOptions', ], ], ], 'DefaultSectionBasedLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'CanvasSizeOptions', ], 'members' => [ 'CanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutCanvasSizeOptions', ], ], ], 'DefaultSliderControlOptions' => [ 'type' => 'structure', 'required' => [ 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlSliderType', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'DefaultTextAreaControlOptions' => [ 'type' => 'structure', 'members' => [ 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'DefaultTextFieldControlOptions' => [ 'type' => 'structure', 'members' => [ 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'DeleteAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], ], ], 'DeleteAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DeleteAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'RecoveryWindowInDays' => [ 'shape' => 'RecoveryWindowInDays', 'location' => 'querystring', 'locationName' => 'recovery-window-in-days', ], 'ForceDeleteWithoutRecovery' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'force-delete-without-recovery', ], ], ], 'DeleteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DeletionTime' => [ 'shape' => 'Timestamp', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DeleteDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DeleteDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteFolderMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'MemberId', 'MemberType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'MemberId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'MemberId', ], 'MemberType' => [ 'shape' => 'MemberType', 'location' => 'uri', 'locationName' => 'MemberType', ], ], ], 'DeleteFolderMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], ], ], 'DeleteFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteIdentityPropagationConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Service', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Service' => [ 'shape' => 'ServiceType', 'location' => 'uri', 'locationName' => 'Service', ], ], ], 'DeleteIdentityPropagationConfigResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'ScheduleId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ScheduleId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'ScheduleId', ], ], ], 'DeleteRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DeleteRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DeleteRoleMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteRoleMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DeleteTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DeleteThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DeleteThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], ], ], 'DeleteThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'DeleteTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], ], ], 'DeleteTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DeleteTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DeleteTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteUserByPrincipalIdRequest' => [ 'type' => 'structure', 'required' => [ 'PrincipalId', 'AwsAccountId', 'Namespace', ], 'members' => [ 'PrincipalId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'PrincipalId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteUserByPrincipalIdResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DeleteVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], ], ], 'DeleteVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'DeletionStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Delimiter' => [ 'type' => 'string', 'max' => 1, 'min' => 1, ], 'DescribeAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'Resolved' => [ 'shape' => 'boolean', 'location' => 'querystring', 'locationName' => 'resolved', ], ], ], 'DescribeAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeAccountSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'AccountSettings' => [ 'shape' => 'AccountSettings', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeAccountSubscriptionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeAccountSubscriptionResponse' => [ 'type' => 'structure', 'members' => [ 'AccountInfo' => [ 'shape' => 'AccountInfo', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Errors' => [ 'shape' => 'AnalysisErrorList', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AnalysisArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'DescribeAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Analysis' => [ 'shape' => 'Analysis', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeAssetBundleExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleExportJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AssetBundleExportJobId', ], ], ], 'DescribeAssetBundleExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleExportJobStatus', ], 'DownloadUrl' => [ 'shape' => 'SensitiveS3Uri', ], 'Errors' => [ 'shape' => 'AssetBundleExportJobErrorList', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'ResourceArns' => [ 'shape' => 'AssetBundleResourceArns', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'CloudFormationOverridePropertyConfiguration' => [ 'shape' => 'AssetBundleCloudFormationOverridePropertyConfiguration', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], 'ValidationStrategy' => [ 'shape' => 'AssetBundleExportJobValidationStrategy', ], 'Warnings' => [ 'shape' => 'AssetBundleExportJobWarningList', ], ], ], 'DescribeAssetBundleImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleImportJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AssetBundleImportJobId', ], ], ], 'DescribeAssetBundleImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobStatus' => [ 'shape' => 'AssetBundleImportJobStatus', ], 'Errors' => [ 'shape' => 'AssetBundleImportJobErrorList', ], 'RollbackErrors' => [ 'shape' => 'AssetBundleImportJobErrorList', ], 'Arn' => [ 'shape' => 'Arn', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'AssetBundleImportSource' => [ 'shape' => 'AssetBundleImportSourceDescription', ], 'OverrideParameters' => [ 'shape' => 'AssetBundleImportJobOverrideParameters', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'OverridePermissions' => [ 'shape' => 'AssetBundleImportJobOverridePermissions', ], 'OverrideTags' => [ 'shape' => 'AssetBundleImportJobOverrideTags', ], 'OverrideValidationStrategy' => [ 'shape' => 'AssetBundleImportJobOverrideValidationStrategy', ], 'Warnings' => [ 'shape' => 'AssetBundleImportJobWarningList', ], ], ], 'DescribeDashboardDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeDashboardDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Errors' => [ 'shape' => 'DashboardErrorList', ], 'Name' => [ 'shape' => 'DashboardName', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], ], ], 'DescribeDashboardPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], ], ], 'DescribeDashboardPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], ], ], 'DescribeDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'Dashboard', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeDashboardSnapshotJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'SnapshotJobId', ], ], ], 'DescribeDashboardSnapshotJobResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UserConfiguration' => [ 'shape' => 'SnapshotUserConfigurationRedacted', ], 'SnapshotConfiguration' => [ 'shape' => 'SnapshotConfiguration', ], 'Arn' => [ 'shape' => 'Arn', ], 'JobStatus' => [ 'shape' => 'SnapshotJobStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeDashboardSnapshotJobResultRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'SnapshotJobId', ], ], ], 'DescribeDashboardSnapshotJobResultResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'JobStatus' => [ 'shape' => 'SnapshotJobStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Result' => [ 'shape' => 'SnapshotJobResult', ], 'ErrorInfo' => [ 'shape' => 'SnapshotJobErrorInfo', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSetPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetArn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'DataSetRefreshProperties' => [ 'shape' => 'DataSetRefreshProperties', ], ], ], 'DescribeDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'DescribeDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'DataSet' => [ 'shape' => 'DataSet', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSourcePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DescribeDataSourcePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], ], ], 'DescribeDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSource' => [ 'shape' => 'DataSource', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeFolderPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'DescribeFolderPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], ], ], 'DescribeFolderResolvedPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'DescribeFolderResolvedPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Folder' => [ 'shape' => 'Folder', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeGroupMembershipRequest' => [ 'type' => 'structure', 'required' => [ 'MemberName', 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'MemberName' => [ 'shape' => 'GroupMemberName', 'location' => 'uri', 'locationName' => 'MemberName', ], 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeGroupMembershipResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMember' => [ 'shape' => 'GroupMember', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'IAMPolicyAssignment' => [ 'shape' => 'IAMPolicyAssignment', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIngestionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'IngestionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'IngestionId' => [ 'shape' => 'IngestionId', 'location' => 'uri', 'locationName' => 'IngestionId', ], ], ], 'DescribeIngestionResponse' => [ 'type' => 'structure', 'members' => [ 'Ingestion' => [ 'shape' => 'Ingestion', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeIpRestrictionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], ], ], 'DescribeIpRestrictionResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'IpRestrictionRuleMap' => [ 'shape' => 'IpRestrictionRuleMap', ], 'VpcIdRestrictionRuleMap' => [ 'shape' => 'VpcIdRestrictionRuleMap', ], 'VpcEndpointIdRestrictionRuleMap' => [ 'shape' => 'VpcEndpointIdRestrictionRuleMap', ], 'Enabled' => [ 'shape' => 'NullableBoolean', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeKeyRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DefaultKeyOnly' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'default-key-only', ], ], ], 'DescribeKeyRegistrationResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'KeyRegistration' => [ 'shape' => 'KeyRegistration', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'Namespace' => [ 'shape' => 'NamespaceInfoV2', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'ScheduleId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'ScheduleId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'ScheduleId', ], ], ], 'DescribeRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshSchedule' => [ 'shape' => 'RefreshSchedule', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'DescribeRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DescribeTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DescribeTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTemplateDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeTemplateDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'TemplateName', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Errors' => [ 'shape' => 'TemplateErrorList', ], 'ResourceStatus' => [ 'shape' => 'ResourceStatus', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTemplatePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], ], ], 'DescribeTemplatePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'Template' => [ 'shape' => 'Template', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], ], ], 'DescribeThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeThemePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], ], ], 'DescribeThemePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAndAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'querystring', 'locationName' => 'version-number', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'querystring', 'locationName' => 'alias-name', ], ], ], 'DescribeThemeResponse' => [ 'type' => 'structure', 'members' => [ 'Theme' => [ 'shape' => 'Theme', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DescribeTopicPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicRefreshRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'RefreshId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'RefreshId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'RefreshId', ], ], ], 'DescribeTopicRefreshResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshDetails' => [ 'shape' => 'TopicRefreshDetails', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], ], ], 'DescribeTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'DescribeTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'DescribeTopicResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'DescribeVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], ], ], 'DescribeVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'VPCConnection' => [ 'shape' => 'VPCConnection', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'DestinationParameterValueConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomValuesConfiguration' => [ 'shape' => 'CustomValuesConfiguration', ], 'SelectAllValueOptions' => [ 'shape' => 'SelectAllValueOptions', ], 'SourceParameterName' => [ 'shape' => 'String', ], 'SourceField' => [ 'shape' => 'FieldId', ], 'SourceColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'DimensionField' => [ 'type' => 'structure', 'members' => [ 'NumericalDimensionField' => [ 'shape' => 'NumericalDimensionField', ], 'CategoricalDimensionField' => [ 'shape' => 'CategoricalDimensionField', ], 'DateDimensionField' => [ 'shape' => 'DateDimensionField', ], ], ], 'DimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 200, ], 'DisplayFormat' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'PERCENT', 'CURRENCY', 'NUMBER', 'DATE', 'STRING', ], ], 'DisplayFormatOptions' => [ 'type' => 'structure', 'members' => [ 'UseBlankCellFormat' => [ 'shape' => 'Boolean', ], 'BlankCellFormat' => [ 'shape' => 'LimitedString', ], 'DateFormat' => [ 'shape' => 'LimitedString', ], 'DecimalSeparator' => [ 'shape' => 'TopicNumericSeparatorSymbol', ], 'GroupingSeparator' => [ 'shape' => 'LimitedString', ], 'UseGrouping' => [ 'shape' => 'Boolean', ], 'FractionDigits' => [ 'shape' => 'Integer', ], 'Prefix' => [ 'shape' => 'LimitedString', ], 'Suffix' => [ 'shape' => 'LimitedString', ], 'UnitScaler' => [ 'shape' => 'NumberScale', ], 'NegativeFormat' => [ 'shape' => 'NegativeFormat', ], 'CurrencySymbol' => [ 'shape' => 'LimitedString', ], ], ], 'DnsResolverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPv4Address', ], 'max' => 15, ], 'Domain' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainNotWhitelistedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'DonutCenterOptions' => [ 'type' => 'structure', 'members' => [ 'LabelVisibility' => [ 'shape' => 'Visibility', ], ], ], 'DonutOptions' => [ 'type' => 'structure', 'members' => [ 'ArcOptions' => [ 'shape' => 'ArcOptions', ], 'DonutCenterOptions' => [ 'shape' => 'DonutCenterOptions', ], ], ], 'Double' => [ 'type' => 'double', ], 'DrillDownFilter' => [ 'type' => 'structure', 'members' => [ 'NumericEqualityFilter' => [ 'shape' => 'NumericEqualityDrillDownFilter', ], 'CategoryFilter' => [ 'shape' => 'CategoryDrillDownFilter', ], 'TimeRangeFilter' => [ 'shape' => 'TimeRangeDrillDownFilter', ], ], ], 'DrillDownFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DrillDownFilter', ], 'max' => 10, ], 'DropDownControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'SelectAllOptions' => [ 'shape' => 'ListControlSelectAllOptions', ], 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'DynamicDefaultValue' => [ 'type' => 'structure', 'required' => [ 'DefaultValueColumn', ], 'members' => [ 'UserNameColumn' => [ 'shape' => 'ColumnIdentifier', ], 'GroupNameColumn' => [ 'shape' => 'ColumnIdentifier', ], 'DefaultValueColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'Edition' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'ENTERPRISE', 'ENTERPRISE_AND_Q', ], ], 'EmbeddingIdentityType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'QUICKSIGHT', 'ANONYMOUS', ], ], 'EmbeddingUrl' => [ 'type' => 'string', 'sensitive' => true, ], 'EmptyVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Entity' => [ 'type' => 'structure', 'members' => [ 'Path' => [ 'shape' => 'NonEmptyString', ], ], ], 'EntityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Entity', ], 'max' => 200, ], 'EntryPath' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'EntryPoint' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ErrorInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'IngestionErrorType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ExasolParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], ], ], 'ExceptionResourceType' => [ 'type' => 'string', 'enum' => [ 'USER', 'GROUP', 'NAMESPACE', 'ACCOUNT_SETTINGS', 'IAMPOLICY_ASSIGNMENT', 'DATA_SOURCE', 'DATA_SET', 'VPC_CONNECTION', 'INGESTION', ], ], 'ExcludePeriodConfiguration' => [ 'type' => 'structure', 'required' => [ 'Amount', 'Granularity', ], 'members' => [ 'Amount' => [ 'shape' => 'Integer', 'box' => true, ], 'Granularity' => [ 'shape' => 'TimeGranularity', ], 'Status' => [ 'shape' => 'WidgetStatus', ], ], ], 'ExplicitHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', 'Columns', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'Columns' => [ 'shape' => 'ExplicitHierarchyColumnList', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'ExplicitHierarchyColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, 'min' => 2, ], 'ExportHiddenFieldsOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ExportToCSVOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'ExportWithHiddenFieldsOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'Expression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'sensitive' => true, ], 'FailedKeyRegistrationEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedKeyRegistrationEntry', ], ], 'FailedKeyRegistrationEntry' => [ 'type' => 'structure', 'required' => [ 'Message', 'StatusCode', 'SenderFault', ], 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'StatusCode' => [ 'shape' => 'StatusCode', ], 'SenderFault' => [ 'shape' => 'Boolean', ], ], ], 'FieldBasedTooltip' => [ 'type' => 'structure', 'members' => [ 'AggregationVisibility' => [ 'shape' => 'Visibility', ], 'TooltipTitleType' => [ 'shape' => 'TooltipTitleType', ], 'TooltipFields' => [ 'shape' => 'TooltipItemList', ], ], ], 'FieldFolder' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'FieldFolderDescription', ], 'columns' => [ 'shape' => 'FolderColumnList', ], ], ], 'FieldFolderDescription' => [ 'type' => 'string', 'max' => 500, ], 'FieldFolderMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FieldFolderPath', ], 'value' => [ 'shape' => 'FieldFolder', ], ], 'FieldFolderPath' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'FieldId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'FieldLabelType' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'FieldOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 200, ], 'FieldSeriesItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'AxisBinding', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'Settings' => [ 'shape' => 'LineChartSeriesSettings', ], ], ], 'FieldSort' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Direction', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Direction' => [ 'shape' => 'SortDirection', ], ], ], 'FieldSortOptions' => [ 'type' => 'structure', 'members' => [ 'FieldSort' => [ 'shape' => 'FieldSort', ], 'ColumnSort' => [ 'shape' => 'ColumnSort', ], ], ], 'FieldSortOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldSortOptions', ], 'max' => 100, ], 'FieldTooltipItem' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Label' => [ 'shape' => 'String', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'TooltipTarget' => [ 'shape' => 'TooltipTarget', ], ], ], 'FieldValue' => [ 'type' => 'string', 'max' => 2048, 'sensitive' => true, ], 'FileFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', 'TSV', 'CLF', 'ELF', 'XLSX', 'JSON', ], ], 'FilledMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Geospatial' => [ 'shape' => 'FilledMapDimensionFieldList', ], 'Values' => [ 'shape' => 'FilledMapMeasureFieldList', ], ], ], 'FilledMapConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'ConditionalFormattingOptions', ], 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'FilledMapConditionalFormattingOptionList', ], ], ], 'FilledMapConditionalFormattingOption' => [ 'type' => 'structure', 'required' => [ 'Shape', ], 'members' => [ 'Shape' => [ 'shape' => 'FilledMapShapeConditionalFormatting', ], ], ], 'FilledMapConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilledMapConditionalFormattingOption', ], 'max' => 200, ], 'FilledMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'FilledMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'FilledMapSortConfiguration', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'WindowOptions' => [ 'shape' => 'GeospatialWindowOptions', ], 'MapStyleOptions' => [ 'shape' => 'GeospatialMapStyleOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'FilledMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'FilledMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'FilledMapAggregatedFieldWells' => [ 'shape' => 'FilledMapAggregatedFieldWells', ], ], ], 'FilledMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'FilledMapShapeConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Format' => [ 'shape' => 'ShapeConditionalFormat', ], ], ], 'FilledMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'FilledMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'FilledMapConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'FilledMapConditionalFormatting', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Filter' => [ 'type' => 'structure', 'members' => [ 'CategoryFilter' => [ 'shape' => 'CategoryFilter', ], 'NumericRangeFilter' => [ 'shape' => 'NumericRangeFilter', ], 'NumericEqualityFilter' => [ 'shape' => 'NumericEqualityFilter', ], 'TimeEqualityFilter' => [ 'shape' => 'TimeEqualityFilter', ], 'TimeRangeFilter' => [ 'shape' => 'TimeRangeFilter', ], 'RelativeDatesFilter' => [ 'shape' => 'RelativeDatesFilter', ], 'TopBottomFilter' => [ 'shape' => 'TopBottomFilter', ], 'NestedFilter' => [ 'shape' => 'NestedFilter', ], ], ], 'FilterAggMetrics' => [ 'type' => 'structure', 'members' => [ 'MetricOperand' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'AggType', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], ], ], 'FilterAggMetricsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterAggMetrics', ], 'max' => 100, ], 'FilterClass' => [ 'type' => 'string', 'enum' => [ 'ENFORCED_VALUE_FILTER', 'CONDITIONAL_VALUE_FILTER', 'NAMED_VALUE_FILTER', ], ], 'FilterControl' => [ 'type' => 'structure', 'members' => [ 'DateTimePicker' => [ 'shape' => 'FilterDateTimePickerControl', ], 'List' => [ 'shape' => 'FilterListControl', ], 'Dropdown' => [ 'shape' => 'FilterDropDownControl', ], 'TextField' => [ 'shape' => 'FilterTextFieldControl', ], 'TextArea' => [ 'shape' => 'FilterTextAreaControl', ], 'Slider' => [ 'shape' => 'FilterSliderControl', ], 'RelativeDateTime' => [ 'shape' => 'FilterRelativeDateTimeControl', ], 'CrossSheet' => [ 'shape' => 'FilterCrossSheetControl', ], ], ], 'FilterControlList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterControl', ], 'max' => 200, ], 'FilterCrossSheetControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterDateTimePickerControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlDateTimePickerType', ], ], ], 'FilterDropDownControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterGroup' => [ 'type' => 'structure', 'required' => [ 'FilterGroupId', 'Filters', 'ScopeConfiguration', 'CrossDataset', ], 'members' => [ 'FilterGroupId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Filters' => [ 'shape' => 'FilterList', ], 'ScopeConfiguration' => [ 'shape' => 'FilterScopeConfiguration', ], 'Status' => [ 'shape' => 'WidgetStatus', ], 'CrossDataset' => [ 'shape' => 'CrossDatasetTypes', ], ], ], 'FilterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterGroup', ], 'max' => 2000, ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, ], 'FilterListConfiguration' => [ 'type' => 'structure', 'required' => [ 'MatchOperator', ], 'members' => [ 'MatchOperator' => [ 'shape' => 'CategoryFilterMatchOperator', ], 'CategoryValues' => [ 'shape' => 'CategoryValueList', ], 'SelectAllOptions' => [ 'shape' => 'CategoryFilterSelectAllOptions', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], ], ], 'FilterListControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'FilterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'FilterNullOption' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', 'NULLS_ONLY', 'NON_NULLS_ONLY', ], ], 'FilterOperation' => [ 'type' => 'structure', 'required' => [ 'ConditionExpression', ], 'members' => [ 'ConditionExpression' => [ 'shape' => 'Expression', ], ], ], 'FilterOperationSelectedFieldsConfiguration' => [ 'type' => 'structure', 'members' => [ 'SelectedFields' => [ 'shape' => 'SelectedFieldList', ], 'SelectedFieldOptions' => [ 'shape' => 'SelectedFieldOptions', ], 'SelectedColumns' => [ 'shape' => 'CustomActionColumnList', ], ], ], 'FilterOperationTargetVisualsConfiguration' => [ 'type' => 'structure', 'members' => [ 'SameSheetTargetVisualConfiguration' => [ 'shape' => 'SameSheetTargetVisualConfiguration', ], ], ], 'FilterOperator' => [ 'type' => 'string', 'enum' => [ 'StringEquals', 'StringLike', ], ], 'FilterRelativeDateTimeControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'RelativeDateTimeControlDisplayOptions', ], ], ], 'FilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [ 'SelectedSheets' => [ 'shape' => 'SelectedSheetsFilterScopeConfiguration', ], 'AllSheets' => [ 'shape' => 'AllSheetsFilterScopeConfiguration', ], ], ], 'FilterSelectableValues' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'ParameterSelectableValueList', ], ], ], 'FilterSliderControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlSliderType', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'FilterTextAreaControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'FilterTextFieldControl' => [ 'type' => 'structure', 'required' => [ 'FilterControlId', 'Title', 'SourceFilterId', ], 'members' => [ 'FilterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceFilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'FilterVisualScope' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', 'SELECTED_VISUALS', ], ], 'FilteredVisualsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 50, ], 'Folder' => [ 'type' => 'structure', 'members' => [ 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'FolderPath' => [ 'shape' => 'Path', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'FolderArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 1, ], 'FolderColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 5000, ], 'FolderFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'PARENT_FOLDER_ARN', 'DIRECT_QUICKSIGHT_OWNER', 'DIRECT_QUICKSIGHT_SOLE_OWNER', 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER', 'QUICKSIGHT_OWNER', 'QUICKSIGHT_VIEWER_OR_OWNER', 'FOLDER_NAME', ], ], 'FolderMember' => [ 'type' => 'structure', 'members' => [ 'MemberId' => [ 'shape' => 'RestrictiveResourceId', ], 'MemberType' => [ 'shape' => 'MemberType', ], ], ], 'FolderMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberIdArnPair', ], 'max' => 100, ], 'FolderName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'FolderSearchFilter' => [ 'type' => 'structure', 'members' => [ 'Operator' => [ 'shape' => 'FilterOperator', ], 'Name' => [ 'shape' => 'FolderFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'FolderSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderSearchFilter', ], 'max' => 100, ], 'FolderSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Name' => [ 'shape' => 'FolderName', ], 'FolderType' => [ 'shape' => 'FolderType', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'SharingModel' => [ 'shape' => 'SharingModel', ], ], ], 'FolderSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderSummary', ], 'max' => 100, ], 'FolderType' => [ 'type' => 'string', 'enum' => [ 'SHARED', 'RESTRICTED', ], ], 'Font' => [ 'type' => 'structure', 'members' => [ 'FontFamily' => [ 'shape' => 'String', ], ], ], 'FontConfiguration' => [ 'type' => 'structure', 'members' => [ 'FontSize' => [ 'shape' => 'FontSize', ], 'FontDecoration' => [ 'shape' => 'FontDecoration', ], 'FontColor' => [ 'shape' => 'HexColor', ], 'FontWeight' => [ 'shape' => 'FontWeight', ], 'FontStyle' => [ 'shape' => 'FontStyle', ], ], ], 'FontDecoration' => [ 'type' => 'string', 'enum' => [ 'UNDERLINE', 'NONE', ], ], 'FontList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Font', ], 'max' => 5, ], 'FontSize' => [ 'type' => 'structure', 'members' => [ 'Relative' => [ 'shape' => 'RelativeFontSize', ], ], ], 'FontStyle' => [ 'type' => 'string', 'enum' => [ 'NORMAL', 'ITALIC', ], ], 'FontWeight' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FontWeightName', ], ], ], 'FontWeightName' => [ 'type' => 'string', 'enum' => [ 'NORMAL', 'BOLD', ], ], 'ForecastComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodsForward' => [ 'shape' => 'PeriodsForward', ], 'PeriodsBackward' => [ 'shape' => 'PeriodsBackward', ], 'UpperBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'LowerBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'PredictionInterval' => [ 'shape' => 'PredictionInterval', ], 'Seasonality' => [ 'shape' => 'ForecastComputationSeasonality', ], 'CustomSeasonalityValue' => [ 'shape' => 'ForecastComputationCustomSeasonalityValue', 'box' => true, ], ], ], 'ForecastComputationCustomSeasonalityValue' => [ 'type' => 'integer', 'max' => 180, 'min' => 1, ], 'ForecastComputationSeasonality' => [ 'type' => 'string', 'enum' => [ 'AUTOMATIC', 'CUSTOM', ], ], 'ForecastConfiguration' => [ 'type' => 'structure', 'members' => [ 'ForecastProperties' => [ 'shape' => 'TimeBasedForecastProperties', ], 'Scenario' => [ 'shape' => 'ForecastScenario', ], ], ], 'ForecastConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastConfiguration', ], 'max' => 10, ], 'ForecastScenario' => [ 'type' => 'structure', 'members' => [ 'WhatIfPointScenario' => [ 'shape' => 'WhatIfPointScenario', ], 'WhatIfRangeScenario' => [ 'shape' => 'WhatIfRangeScenario', ], ], ], 'FormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'StringFormatConfiguration' => [ 'shape' => 'StringFormatConfiguration', ], 'NumberFormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], 'DateTimeFormatConfiguration' => [ 'shape' => 'DateTimeFormatConfiguration', ], ], ], 'FreeFormLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'ScreenCanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutScreenCanvasSizeOptions', ], ], ], 'FreeFormLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'FreeFromLayoutElementList', ], 'CanvasSizeOptions' => [ 'shape' => 'FreeFormLayoutCanvasSizeOptions', ], ], ], 'FreeFormLayoutElement' => [ 'type' => 'structure', 'required' => [ 'ElementId', 'ElementType', 'XAxisLocation', 'YAxisLocation', 'Width', 'Height', ], 'members' => [ 'ElementId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ElementType' => [ 'shape' => 'LayoutElementType', ], 'XAxisLocation' => [ 'shape' => 'PixelLength', ], 'YAxisLocation' => [ 'shape' => 'UnlimitedPixelLength', ], 'Width' => [ 'shape' => 'PixelLength', ], 'Height' => [ 'shape' => 'PixelLength', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'RenderingRules' => [ 'shape' => 'SheetElementRenderingRuleList', ], 'BorderStyle' => [ 'shape' => 'FreeFormLayoutElementBorderStyle', ], 'SelectedBorderStyle' => [ 'shape' => 'FreeFormLayoutElementBorderStyle', ], 'BackgroundStyle' => [ 'shape' => 'FreeFormLayoutElementBackgroundStyle', ], 'LoadingAnimation' => [ 'shape' => 'LoadingAnimation', ], ], ], 'FreeFormLayoutElementBackgroundStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Color' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'FreeFormLayoutElementBorderStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Color' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'FreeFormLayoutScreenCanvasSizeOptions' => [ 'type' => 'structure', 'required' => [ 'OptimizedViewPortWidth', ], 'members' => [ 'OptimizedViewPortWidth' => [ 'shape' => 'PixelLength', 'box' => true, ], ], ], 'FreeFormSectionLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'FreeFromLayoutElementList', ], ], ], 'FreeFromLayoutElementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FreeFormLayoutElement', ], 'max' => 430, ], 'FunnelChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'FunnelChartDimensionFieldList', ], 'Values' => [ 'shape' => 'FunnelChartMeasureFieldList', ], ], ], 'FunnelChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'FunnelChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'FunnelChartSortConfiguration', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'DataLabelOptions' => [ 'shape' => 'FunnelChartDataLabelOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'FunnelChartDataLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CategoryLabelVisibility' => [ 'shape' => 'Visibility', ], 'MeasureLabelVisibility' => [ 'shape' => 'Visibility', ], 'Position' => [ 'shape' => 'DataLabelPosition', ], 'LabelFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'LabelColor' => [ 'shape' => 'HexColor', ], 'MeasureDataLabelStyle' => [ 'shape' => 'FunnelChartMeasureDataLabelStyle', ], ], ], 'FunnelChartDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'FunnelChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'FunnelChartAggregatedFieldWells' => [ 'shape' => 'FunnelChartAggregatedFieldWells', ], ], ], 'FunnelChartMeasureDataLabelStyle' => [ 'type' => 'string', 'enum' => [ 'VALUE_ONLY', 'PERCENTAGE_BY_FIRST_STAGE', 'PERCENTAGE_BY_PREVIOUS_STAGE', 'VALUE_AND_PERCENTAGE_BY_FIRST_STAGE', 'VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE', ], ], 'FunnelChartMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'FunnelChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'FunnelChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'FunnelChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'GaugeChartArcConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'GaugeChartColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'HexColor', ], 'BackgroundColor' => [ 'shape' => 'HexColor', ], ], ], 'GaugeChartConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'GaugeChartConditionalFormattingOptionList', ], ], ], 'GaugeChartConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'PrimaryValue' => [ 'shape' => 'GaugeChartPrimaryValueConditionalFormatting', ], 'Arc' => [ 'shape' => 'GaugeChartArcConditionalFormatting', ], ], ], 'GaugeChartConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GaugeChartConditionalFormattingOption', ], 'max' => 100, ], 'GaugeChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'GaugeChartFieldWells', ], 'GaugeChartOptions' => [ 'shape' => 'GaugeChartOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'TooltipOptions' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ColorConfiguration' => [ 'shape' => 'GaugeChartColorConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'GaugeChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'MeasureFieldList', ], 'TargetValues' => [ 'shape' => 'MeasureFieldList', ], ], ], 'GaugeChartOptions' => [ 'type' => 'structure', 'members' => [ 'PrimaryValueDisplayType' => [ 'shape' => 'PrimaryValueDisplayType', ], 'Comparison' => [ 'shape' => 'ComparisonConfiguration', ], 'ArcAxis' => [ 'shape' => 'ArcAxisConfiguration', ], 'Arc' => [ 'shape' => 'ArcConfiguration', ], 'PrimaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], ], ], 'GaugeChartPrimaryValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'GaugeChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'GaugeChartConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'GaugeChartConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'GenerateEmbedUrlForAnonymousUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'AuthorizedResourceArns', 'ExperienceConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'SessionTags' => [ 'shape' => 'SessionTagList', ], 'AuthorizedResourceArns' => [ 'shape' => 'ArnList', ], 'ExperienceConfiguration' => [ 'shape' => 'AnonymousUserEmbeddingExperienceConfiguration', ], 'AllowedDomains' => [ 'shape' => 'StringList', ], ], ], 'GenerateEmbedUrlForAnonymousUserResponse' => [ 'type' => 'structure', 'required' => [ 'EmbedUrl', 'Status', 'RequestId', 'AnonymousUserArn', ], 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'AnonymousUserArn' => [ 'shape' => 'Arn', ], ], ], 'GenerateEmbedUrlForRegisteredUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'UserArn', 'ExperienceConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', ], 'UserArn' => [ 'shape' => 'Arn', ], 'ExperienceConfiguration' => [ 'shape' => 'RegisteredUserEmbeddingExperienceConfiguration', ], 'AllowedDomains' => [ 'shape' => 'StringList', ], ], ], 'GenerateEmbedUrlForRegisteredUserResponse' => [ 'type' => 'structure', 'required' => [ 'EmbedUrl', 'Status', 'RequestId', ], 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GeoSpatialColumnGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Columns', ], 'members' => [ 'Name' => [ 'shape' => 'ColumnGroupName', ], 'CountryCode' => [ 'shape' => 'GeoSpatialCountryCode', ], 'Columns' => [ 'shape' => 'ColumnList', ], ], ], 'GeoSpatialCountryCode' => [ 'type' => 'string', 'enum' => [ 'US', ], ], 'GeoSpatialDataRole' => [ 'type' => 'string', 'enum' => [ 'COUNTRY', 'STATE', 'COUNTY', 'CITY', 'POSTCODE', 'LONGITUDE', 'LATITUDE', ], ], 'GeospatialCoordinateBounds' => [ 'type' => 'structure', 'required' => [ 'North', 'South', 'West', 'East', ], 'members' => [ 'North' => [ 'shape' => 'Latitude', ], 'South' => [ 'shape' => 'Latitude', ], 'West' => [ 'shape' => 'Longitude', ], 'East' => [ 'shape' => 'Longitude', ], ], ], 'GeospatialHeatmapColorScale' => [ 'type' => 'structure', 'members' => [ 'Colors' => [ 'shape' => 'GeospatialHeatmapDataColorList', ], ], ], 'GeospatialHeatmapConfiguration' => [ 'type' => 'structure', 'members' => [ 'HeatmapColor' => [ 'shape' => 'GeospatialHeatmapColorScale', ], ], ], 'GeospatialHeatmapDataColor' => [ 'type' => 'structure', 'required' => [ 'Color', ], 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], ], ], 'GeospatialHeatmapDataColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GeospatialHeatmapDataColor', ], 'max' => 2, 'min' => 2, ], 'GeospatialMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Geospatial' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], ], ], 'GeospatialMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'GeospatialMapFieldWells', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'WindowOptions' => [ 'shape' => 'GeospatialWindowOptions', ], 'MapStyleOptions' => [ 'shape' => 'GeospatialMapStyleOptions', ], 'PointStyleOptions' => [ 'shape' => 'GeospatialPointStyleOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'GeospatialMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'GeospatialMapAggregatedFieldWells' => [ 'shape' => 'GeospatialMapAggregatedFieldWells', ], ], ], 'GeospatialMapStyleOptions' => [ 'type' => 'structure', 'members' => [ 'BaseMapStyle' => [ 'shape' => 'BaseMapStyleType', ], ], ], 'GeospatialMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'GeospatialMapConfiguration', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'GeospatialPointStyleOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedPointStyle' => [ 'shape' => 'GeospatialSelectedPointStyle', ], 'ClusterMarkerConfiguration' => [ 'shape' => 'ClusterMarkerConfiguration', ], 'HeatmapConfiguration' => [ 'shape' => 'GeospatialHeatmapConfiguration', ], ], ], 'GeospatialSelectedPointStyle' => [ 'type' => 'string', 'enum' => [ 'POINT', 'CLUSTER', 'HEATMAP', ], ], 'GeospatialWindowOptions' => [ 'type' => 'structure', 'members' => [ 'Bounds' => [ 'shape' => 'GeospatialCoordinateBounds', ], 'MapZoomMode' => [ 'shape' => 'MapZoomMode', ], ], ], 'GetDashboardEmbedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'IdentityType', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'IdentityType' => [ 'shape' => 'EmbeddingIdentityType', 'location' => 'querystring', 'locationName' => 'creds-type', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', 'location' => 'querystring', 'locationName' => 'session-lifetime', ], 'UndoRedoDisabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'undo-redo-disabled', ], 'ResetDisabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'reset-disabled', ], 'StatePersistenceEnabled' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'state-persistence-enabled', ], 'UserArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'user-arn', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AdditionalDashboardIds' => [ 'shape' => 'AdditionalDashboardIdList', 'location' => 'querystring', 'locationName' => 'additional-dashboard-ids', ], ], ], 'GetDashboardEmbedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GetSessionEmbedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'EntryPoint' => [ 'shape' => 'EntryPoint', 'location' => 'querystring', 'locationName' => 'entry-point', ], 'SessionLifetimeInMinutes' => [ 'shape' => 'SessionLifetimeInMinutes', 'location' => 'querystring', 'locationName' => 'session-lifetime', ], 'UserArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'user-arn', ], ], ], 'GetSessionEmbedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'EmbedUrl' => [ 'shape' => 'EmbeddingUrl', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'GlobalTableBorderOptions' => [ 'type' => 'structure', 'members' => [ 'UniformBorder' => [ 'shape' => 'TableBorderOptions', ], 'SideSpecificBorder' => [ 'shape' => 'TableSideBorderOptions', ], ], ], 'GradientColor' => [ 'type' => 'structure', 'members' => [ 'Stops' => [ 'shape' => 'GradientStopList', ], ], ], 'GradientStop' => [ 'type' => 'structure', 'required' => [ 'GradientOffset', ], 'members' => [ 'GradientOffset' => [ 'shape' => 'Double', ], 'DataValue' => [ 'shape' => 'Double', 'box' => true, ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'GradientStopList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GradientStop', ], 'max' => 100, ], 'GridLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'ScreenCanvasSizeOptions' => [ 'shape' => 'GridLayoutScreenCanvasSizeOptions', ], ], ], 'GridLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'Elements', ], 'members' => [ 'Elements' => [ 'shape' => 'GridLayoutElementList', ], 'CanvasSizeOptions' => [ 'shape' => 'GridLayoutCanvasSizeOptions', ], ], ], 'GridLayoutElement' => [ 'type' => 'structure', 'required' => [ 'ElementId', 'ElementType', 'ColumnSpan', 'RowSpan', ], 'members' => [ 'ElementId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ElementType' => [ 'shape' => 'LayoutElementType', ], 'ColumnIndex' => [ 'shape' => 'GridLayoutElementColumnIndex', ], 'ColumnSpan' => [ 'shape' => 'GridLayoutElementColumnSpan', ], 'RowIndex' => [ 'shape' => 'GridLayoutElementRowIndex', ], 'RowSpan' => [ 'shape' => 'GridLayoutElementRowSpan', ], ], ], 'GridLayoutElementColumnIndex' => [ 'type' => 'integer', 'max' => 35, 'min' => 0, ], 'GridLayoutElementColumnSpan' => [ 'type' => 'integer', 'max' => 36, 'min' => 1, ], 'GridLayoutElementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GridLayoutElement', ], 'max' => 430, ], 'GridLayoutElementRowIndex' => [ 'type' => 'integer', 'max' => 9009, 'min' => 0, ], 'GridLayoutElementRowSpan' => [ 'type' => 'integer', 'max' => 21, 'min' => 1, ], 'GridLayoutScreenCanvasSizeOptions' => [ 'type' => 'structure', 'required' => [ 'ResizeOption', ], 'members' => [ 'ResizeOption' => [ 'shape' => 'ResizeOption', ], 'OptimizedViewPortWidth' => [ 'shape' => 'PixelLength', 'box' => true, ], ], ], 'Group' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'GroupName' => [ 'shape' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'PrincipalId' => [ 'shape' => 'String', ], ], ], 'GroupDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'GroupFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'GROUP_NAME', ], ], 'GroupFilterOperator' => [ 'type' => 'string', 'enum' => [ 'StartsWith', ], ], 'GroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], ], 'GroupMember' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'MemberName' => [ 'shape' => 'GroupMemberName', ], ], ], 'GroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupMember', ], ], 'GroupMemberName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'GroupName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'GroupSearchFilter' => [ 'type' => 'structure', 'required' => [ 'Operator', 'Name', 'Value', ], 'members' => [ 'Operator' => [ 'shape' => 'GroupFilterOperator', ], 'Name' => [ 'shape' => 'GroupFilterAttribute', ], 'Value' => [ 'shape' => 'String', ], ], ], 'GroupSearchFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupSearchFilter', ], 'max' => 1, 'min' => 1, ], 'GroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'GrowthRateComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodSize' => [ 'shape' => 'GrowthRatePeriodSize', ], ], ], 'GrowthRatePeriodSize' => [ 'type' => 'integer', 'max' => 52, 'min' => 2, ], 'GutterStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'HeaderFooterSectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'SectionId', 'Layout', ], 'members' => [ 'SectionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Layout' => [ 'shape' => 'SectionLayoutConfiguration', ], 'Style' => [ 'shape' => 'SectionStyle', ], ], ], 'HeaderFooterSectionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HeaderFooterSectionConfiguration', ], 'max' => 1, ], 'HeatMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Rows' => [ 'shape' => 'HeatMapDimensionFieldList', ], 'Columns' => [ 'shape' => 'HeatMapDimensionFieldList', ], 'Values' => [ 'shape' => 'HeatMapMeasureFieldList', ], ], ], 'HeatMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'HeatMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'HeatMapSortConfiguration', ], 'RowLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColumnLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorScale' => [ 'shape' => 'ColorScale', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'HeatMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'HeatMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'HeatMapAggregatedFieldWells' => [ 'shape' => 'HeatMapAggregatedFieldWells', ], ], ], 'HeatMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'HeatMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'HeatMapRowSort' => [ 'shape' => 'FieldSortOptionsList', ], 'HeatMapColumnSort' => [ 'shape' => 'FieldSortOptionsList', ], 'HeatMapRowItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'HeatMapColumnItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'HeatMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'HeatMapConfiguration', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'HexColor' => [ 'type' => 'string', 'pattern' => '^#[A-F0-9]{6}$', ], 'HexColorWithTransparency' => [ 'type' => 'string', 'pattern' => '^#[A-F0-9]{6}(?:[A-F0-9]{2})?$', ], 'HierarchyId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'HistogramAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'HistogramMeasureFieldList', ], ], ], 'HistogramBinOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedBinType' => [ 'shape' => 'HistogramBinType', ], 'BinCount' => [ 'shape' => 'BinCountOptions', ], 'BinWidth' => [ 'shape' => 'BinWidthOptions', ], 'StartValue' => [ 'shape' => 'Double', 'box' => true, ], ], ], 'HistogramBinType' => [ 'type' => 'string', 'enum' => [ 'BIN_COUNT', 'BIN_WIDTH', ], ], 'HistogramConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'HistogramFieldWells', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'YAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'BinOptions' => [ 'shape' => 'HistogramBinOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'HistogramFieldWells' => [ 'type' => 'structure', 'members' => [ 'HistogramAggregatedFieldWells' => [ 'shape' => 'HistogramAggregatedFieldWells', ], ], ], 'HistogramMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'HistogramVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'HistogramConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'HorizontalTextAlignment' => [ 'type' => 'string', 'enum' => [ 'LEFT', 'CENTER', 'RIGHT', 'AUTO', ], ], 'Host' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'IAMPolicyAssignment' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'AssignmentId' => [ 'shape' => 'String', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], ], ], 'IAMPolicyAssignmentName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$', ], 'IAMPolicyAssignmentSummary' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], ], ], 'IAMPolicyAssignmentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IAMPolicyAssignmentSummary', ], ], 'IPv4Address' => [ 'type' => 'string', 'max' => 15, 'min' => 7, ], 'Icon' => [ 'type' => 'string', 'enum' => [ 'CARET_UP', 'CARET_DOWN', 'PLUS', 'MINUS', 'ARROW_UP', 'ARROW_DOWN', 'ARROW_LEFT', 'ARROW_UP_LEFT', 'ARROW_DOWN_LEFT', 'ARROW_RIGHT', 'ARROW_UP_RIGHT', 'ARROW_DOWN_RIGHT', 'FACE_UP', 'FACE_DOWN', 'FACE_FLAT', 'ONE_BAR', 'TWO_BAR', 'THREE_BAR', 'CIRCLE', 'TRIANGLE', 'SQUARE', 'FLAG', 'THUMBS_UP', 'THUMBS_DOWN', 'CHECKMARK', 'X', ], ], 'Identifier' => [ 'type' => 'structure', 'required' => [ 'Identity', ], 'members' => [ 'Identity' => [ 'shape' => 'LimitedString', ], ], ], 'IdentityCenterConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableIdentityPropagation' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'IdentityMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'IdentityNameList', ], ], 'IdentityName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'IdentityNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityName', ], ], 'IdentityStore' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT', ], ], 'IdentityType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'QUICKSIGHT', 'IAM_IDENTITY_CENTER', ], ], 'IdentityTypeNotSupportedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'IncrementalRefresh' => [ 'type' => 'structure', 'required' => [ 'LookbackWindow', ], 'members' => [ 'LookbackWindow' => [ 'shape' => 'LookbackWindow', ], ], ], 'Ingestion' => [ 'type' => 'structure', 'required' => [ 'Arn', 'IngestionStatus', 'CreatedTime', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'IngestionId', ], 'IngestionStatus' => [ 'shape' => 'IngestionStatus', ], 'ErrorInfo' => [ 'shape' => 'ErrorInfo', ], 'RowInfo' => [ 'shape' => 'RowInfo', ], 'QueueInfo' => [ 'shape' => 'QueueInfo', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'IngestionTimeInSeconds' => [ 'shape' => 'Long', 'box' => true, ], 'IngestionSizeInBytes' => [ 'shape' => 'Long', 'box' => true, ], 'RequestSource' => [ 'shape' => 'IngestionRequestSource', ], 'RequestType' => [ 'shape' => 'IngestionRequestType', ], ], ], 'IngestionErrorType' => [ 'type' => 'string', 'enum' => [ 'FAILURE_TO_ASSUME_ROLE', 'INGESTION_SUPERSEDED', 'INGESTION_CANCELED', 'DATA_SET_DELETED', 'DATA_SET_NOT_SPICE', 'S3_UPLOADED_FILE_DELETED', 'S3_MANIFEST_ERROR', 'DATA_TOLERANCE_EXCEPTION', 'SPICE_TABLE_NOT_FOUND', 'DATA_SET_SIZE_LIMIT_EXCEEDED', 'ROW_SIZE_LIMIT_EXCEEDED', 'ACCOUNT_CAPACITY_LIMIT_EXCEEDED', 'CUSTOMER_ERROR', 'DATA_SOURCE_NOT_FOUND', 'IAM_ROLE_NOT_AVAILABLE', 'CONNECTION_FAILURE', 'SQL_TABLE_NOT_FOUND', 'PERMISSION_DENIED', 'SSL_CERTIFICATE_VALIDATION_FAILURE', 'OAUTH_TOKEN_FAILURE', 'SOURCE_API_LIMIT_EXCEEDED_FAILURE', 'PASSWORD_AUTHENTICATION_FAILURE', 'SQL_SCHEMA_MISMATCH_ERROR', 'INVALID_DATE_FORMAT', 'INVALID_DATAPREP_SYNTAX', 'SOURCE_RESOURCE_LIMIT_EXCEEDED', 'SQL_INVALID_PARAMETER_VALUE', 'QUERY_TIMEOUT', 'SQL_NUMERIC_OVERFLOW', 'UNRESOLVABLE_HOST', 'UNROUTABLE_HOST', 'SQL_EXCEPTION', 'S3_FILE_INACCESSIBLE', 'IOT_FILE_NOT_FOUND', 'IOT_DATA_SET_FILE_EMPTY', 'INVALID_DATA_SOURCE_CONFIG', 'DATA_SOURCE_AUTH_FAILED', 'DATA_SOURCE_CONNECTION_FAILED', 'FAILURE_TO_PROCESS_JSON_FILE', 'INTERNAL_SERVICE_ERROR', 'REFRESH_SUPPRESSED_BY_EDIT', 'PERMISSION_NOT_FOUND', 'ELASTICSEARCH_CURSOR_NOT_ENABLED', 'CURSOR_NOT_ENABLED', 'DUPLICATE_COLUMN_NAMES_FOUND', ], ], 'IngestionId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_]+$', ], 'IngestionMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'IngestionRequestSource' => [ 'type' => 'string', 'enum' => [ 'MANUAL', 'SCHEDULED', ], ], 'IngestionRequestType' => [ 'type' => 'string', 'enum' => [ 'INITIAL_INGESTION', 'EDIT', 'INCREMENTAL_REFRESH', 'FULL_REFRESH', ], ], 'IngestionStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'QUEUED', 'RUNNING', 'FAILED', 'COMPLETED', 'CANCELLED', ], ], 'IngestionType' => [ 'type' => 'string', 'enum' => [ 'INCREMENTAL_REFRESH', 'FULL_REFRESH', ], ], 'Ingestions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ingestion', ], ], 'InnerFilter' => [ 'type' => 'structure', 'members' => [ 'CategoryInnerFilter' => [ 'shape' => 'CategoryInnerFilter', ], ], ], 'InputColumn' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ColumnName', ], 'Type' => [ 'shape' => 'InputColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], ], ], 'InputColumnDataType' => [ 'type' => 'string', 'enum' => [ 'STRING', 'INTEGER', 'DECIMAL', 'DATETIME', 'BIT', 'BOOLEAN', 'JSON', ], ], 'InputColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputColumn', ], 'max' => 2048, 'min' => 1, ], 'InsightConfiguration' => [ 'type' => 'structure', 'members' => [ 'Computations' => [ 'shape' => 'ComputationList', ], 'CustomNarrative' => [ 'shape' => 'CustomNarrativeOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'InsightVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', 'DataSetIdentifier', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'InsightConfiguration' => [ 'shape' => 'InsightConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], ], ], 'InstanceId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'IntegerDatasetParameterDefaultValues', ], ], ], 'IntegerDatasetParameterDefaultValue' => [ 'type' => 'long', ], 'IntegerDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'IntegerDatasetParameterValueList', ], ], ], 'IntegerDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'IntegerDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveLongObject', ], 'max' => 50000, ], 'IntegerDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'IntegerDefaultValueList', ], ], ], 'IntegerParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveLongList', ], ], ], 'IntegerParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'IntegerDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'IntegerValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'IntegerParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameter', ], 'max' => 100, ], 'IntegerValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveLong', 'box' => true, ], ], ], 'InternalFailureException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTopicReviewedAnswer' => [ 'type' => 'structure', 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], 'Error' => [ 'shape' => 'ReviewedAnswerErrorCode', ], ], ], 'InvalidTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvalidTopicReviewedAnswer', ], ], 'IpRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'IpRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CIDR', ], 'value' => [ 'shape' => 'IpRestrictionRuleDescription', ], ], 'ItemsLimitConfiguration' => [ 'type' => 'structure', 'members' => [ 'ItemsLimit' => [ 'shape' => 'Long', 'box' => true, ], 'OtherCategories' => [ 'shape' => 'OtherCategories', ], ], ], 'JiraParameters' => [ 'type' => 'structure', 'required' => [ 'SiteBaseUrl', ], 'members' => [ 'SiteBaseUrl' => [ 'shape' => 'SiteBaseUrl', ], ], ], 'JoinInstruction' => [ 'type' => 'structure', 'required' => [ 'LeftOperand', 'RightOperand', 'Type', 'OnClause', ], 'members' => [ 'LeftOperand' => [ 'shape' => 'LogicalTableId', ], 'RightOperand' => [ 'shape' => 'LogicalTableId', ], 'LeftJoinKeyProperties' => [ 'shape' => 'JoinKeyProperties', ], 'RightJoinKeyProperties' => [ 'shape' => 'JoinKeyProperties', ], 'Type' => [ 'shape' => 'JoinType', ], 'OnClause' => [ 'shape' => 'OnClause', ], ], ], 'JoinKeyProperties' => [ 'type' => 'structure', 'members' => [ 'UniqueKey' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'JoinType' => [ 'type' => 'string', 'enum' => [ 'INNER', 'OUTER', 'LEFT', 'RIGHT', ], ], 'KPIActualValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIComparisonValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'KPIConditionalFormattingOptionList', ], ], ], 'KPIConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'PrimaryValue' => [ 'shape' => 'KPIPrimaryValueConditionalFormatting', ], 'ProgressBar' => [ 'shape' => 'KPIProgressBarConditionalFormatting', ], 'ActualValue' => [ 'shape' => 'KPIActualValueConditionalFormatting', ], 'ComparisonValue' => [ 'shape' => 'KPIComparisonValueConditionalFormatting', ], ], ], 'KPIConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KPIConditionalFormattingOption', ], 'max' => 100, ], 'KPIConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'KPIFieldWells', ], 'SortConfiguration' => [ 'shape' => 'KPISortConfiguration', ], 'KPIOptions' => [ 'shape' => 'KPIOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'KPIFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'MeasureFieldList', ], 'TargetValues' => [ 'shape' => 'MeasureFieldList', ], 'TrendGroups' => [ 'shape' => 'DimensionFieldList', ], ], ], 'KPIOptions' => [ 'type' => 'structure', 'members' => [ 'ProgressBar' => [ 'shape' => 'ProgressBarOptions', ], 'TrendArrows' => [ 'shape' => 'TrendArrowOptions', ], 'SecondaryValue' => [ 'shape' => 'SecondaryValueOptions', ], 'Comparison' => [ 'shape' => 'ComparisonConfiguration', ], 'PrimaryValueDisplayType' => [ 'shape' => 'PrimaryValueDisplayType', ], 'PrimaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'SecondaryValueFontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'Sparkline' => [ 'shape' => 'KPISparklineOptions', ], 'VisualLayoutOptions' => [ 'shape' => 'KPIVisualLayoutOptions', ], ], ], 'KPIPrimaryValueConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'KPIProgressBarConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ForegroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'KPISortConfiguration' => [ 'type' => 'structure', 'members' => [ 'TrendGroupSort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'KPISparklineOptions' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Type' => [ 'shape' => 'KPISparklineType', ], 'Color' => [ 'shape' => 'HexColor', ], 'TooltipVisibility' => [ 'shape' => 'Visibility', ], ], ], 'KPISparklineType' => [ 'type' => 'string', 'enum' => [ 'LINE', 'AREA', ], ], 'KPIVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'KPIConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'KPIConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'KPIVisualLayoutOptions' => [ 'type' => 'structure', 'members' => [ 'StandardLayout' => [ 'shape' => 'KPIVisualStandardLayout', ], ], ], 'KPIVisualStandardLayout' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'KPIVisualStandardLayoutType', ], ], ], 'KPIVisualStandardLayoutType' => [ 'type' => 'string', 'enum' => [ 'CLASSIC', 'VERTICAL', ], ], 'KeyRegistration' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegisteredCustomerManagedKey', ], ], 'LabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'CustomLabel' => [ 'shape' => 'String', ], ], ], 'Latitude' => [ 'type' => 'double', 'max' => 90, 'min' => -90, ], 'Layout' => [ 'type' => 'structure', 'required' => [ 'Configuration', ], 'members' => [ 'Configuration' => [ 'shape' => 'LayoutConfiguration', ], ], ], 'LayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'GridLayout' => [ 'shape' => 'GridLayoutConfiguration', ], 'FreeFormLayout' => [ 'shape' => 'FreeFormLayoutConfiguration', ], 'SectionBasedLayout' => [ 'shape' => 'SectionBasedLayoutConfiguration', ], ], ], 'LayoutElementType' => [ 'type' => 'string', 'enum' => [ 'VISUAL', 'FILTER_CONTROL', 'PARAMETER_CONTROL', 'TEXT_BOX', ], ], 'LayoutList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Layout', ], 'max' => 1, 'min' => 1, ], 'LegendOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'Title' => [ 'shape' => 'LabelOptions', ], 'Position' => [ 'shape' => 'LegendPosition', ], 'Width' => [ 'shape' => 'PixelLength', ], 'Height' => [ 'shape' => 'PixelLength', ], ], ], 'LegendPosition' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'RIGHT', 'BOTTOM', 'TOP', ], ], 'Length' => [ 'type' => 'string', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitedString' => [ 'type' => 'string', 'max' => 256, ], 'LineChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Colors' => [ 'shape' => 'DimensionFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'LineChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'LineChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'LineChartSortConfiguration', ], 'ForecastConfigurations' => [ 'shape' => 'ForecastConfigurationList', ], 'Type' => [ 'shape' => 'LineChartType', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'LineSeriesAxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SecondaryYAxisDisplayOptions' => [ 'shape' => 'LineSeriesAxisDisplayOptions', ], 'SecondaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SingleAxisOptions' => [ 'shape' => 'SingleAxisOptions', ], 'DefaultSeriesSettings' => [ 'shape' => 'LineChartDefaultSeriesSettings', ], 'Series' => [ 'shape' => 'SeriesItemList', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'ReferenceLines' => [ 'shape' => 'ReferenceLineList', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'LineChartDefaultSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'LineStyleSettings' => [ 'shape' => 'LineChartLineStyleSettings', ], 'MarkerStyleSettings' => [ 'shape' => 'LineChartMarkerStyleSettings', ], ], ], 'LineChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'LineChartAggregatedFieldWells' => [ 'shape' => 'LineChartAggregatedFieldWells', ], ], ], 'LineChartLineStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DOTTED', 'DASHED', ], ], 'LineChartLineStyleSettings' => [ 'type' => 'structure', 'members' => [ 'LineVisibility' => [ 'shape' => 'Visibility', ], 'LineInterpolation' => [ 'shape' => 'LineInterpolation', ], 'LineStyle' => [ 'shape' => 'LineChartLineStyle', ], 'LineWidth' => [ 'shape' => 'PixelLength', ], ], ], 'LineChartMarkerShape' => [ 'type' => 'string', 'enum' => [ 'CIRCLE', 'TRIANGLE', 'SQUARE', 'DIAMOND', 'ROUNDED_SQUARE', ], ], 'LineChartMarkerStyleSettings' => [ 'type' => 'structure', 'members' => [ 'MarkerVisibility' => [ 'shape' => 'Visibility', ], 'MarkerShape' => [ 'shape' => 'LineChartMarkerShape', ], 'MarkerSize' => [ 'shape' => 'PixelLength', ], 'MarkerColor' => [ 'shape' => 'HexColor', ], ], ], 'LineChartSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'LineStyleSettings' => [ 'shape' => 'LineChartLineStyleSettings', ], 'MarkerStyleSettings' => [ 'shape' => 'LineChartMarkerStyleSettings', ], ], ], 'LineChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'LineChartType' => [ 'type' => 'string', 'enum' => [ 'LINE', 'AREA', 'STACKED_AREA', ], ], 'LineChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'LineChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'LineInterpolation' => [ 'type' => 'string', 'enum' => [ 'LINEAR', 'SMOOTH', 'STEPPED', ], ], 'LineSeriesAxisDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'AxisOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'MissingDataConfigurations' => [ 'shape' => 'MissingDataConfigurationList', ], ], ], 'LinkEntityArn' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}', ], 'LinkEntityArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkEntityArn', ], 'max' => 5, ], 'LinkSharingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'ListAnalysesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAnalysesResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisSummaryList' => [ 'shape' => 'AnalysisSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListAssetBundleExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAssetBundleExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'AssetBundleExportJobSummaryList' => [ 'shape' => 'AssetBundleExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListAssetBundleImportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListAssetBundleImportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'AssetBundleImportJobSummaryList' => [ 'shape' => 'AssetBundleImportJobSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'SearchOptions' => [ 'shape' => 'ListControlSearchOptions', ], 'SelectAllOptions' => [ 'shape' => 'ListControlSelectAllOptions', ], 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'ListControlSearchOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ListControlSelectAllOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ListDashboardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDashboardVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardVersionSummaryList' => [ 'shape' => 'DashboardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListDashboardsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDashboardsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardSummaryList' => [ 'shape' => 'DashboardSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListDataSetsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDataSetsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetSummaries' => [ 'shape' => 'DataSetSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListFolderMembersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListFolderMembersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderMemberList' => [ 'shape' => 'FolderMemberList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListFoldersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListFoldersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderSummaryList' => [ 'shape' => 'FolderSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListGroupMembershipsRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListGroupMembershipsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupMemberList' => [ 'shape' => 'GroupMemberList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIAMPolicyAssignmentsForUserRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'UserName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListIAMPolicyAssignmentsForUserResponse' => [ 'type' => 'structure', 'members' => [ 'ActiveAssignments' => [ 'shape' => 'ActiveIAMPolicyAssignmentList', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIAMPolicyAssignmentsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', 'location' => 'querystring', 'locationName' => 'assignment-status', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListIAMPolicyAssignmentsResponse' => [ 'type' => 'structure', 'members' => [ 'IAMPolicyAssignments' => [ 'shape' => 'IAMPolicyAssignmentSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListIdentityPropagationConfigsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'MaxResults' => [ 'shape' => 'ListIdentityPropagationMaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], ], ], 'ListIdentityPropagationConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'Services' => [ 'shape' => 'AuthorizedTargetsByServices', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListIdentityPropagationMaxResults' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'ListIngestionsRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', ], 'members' => [ 'DataSetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'MaxResults' => [ 'shape' => 'IngestionMaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListIngestionsResponse' => [ 'type' => 'structure', 'members' => [ 'Ingestions' => [ 'shape' => 'Ingestions', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListNamespacesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListNamespacesResponse' => [ 'type' => 'structure', 'members' => [ 'Namespaces' => [ 'shape' => 'Namespaces', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListRefreshSchedulesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], ], ], 'ListRefreshSchedulesResponse' => [ 'type' => 'structure', 'members' => [ 'RefreshSchedules' => [ 'shape' => 'RefreshSchedules', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListRoleMembershipsRequest' => [ 'type' => 'structure', 'required' => [ 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListRoleMembershipsResponse' => [ 'type' => 'structure', 'members' => [ 'MembersList' => [ 'shape' => 'GroupsList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListTemplateAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListTemplateAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAliasList' => [ 'shape' => 'TemplateAliasList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListTemplateVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListTemplateVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateVersionSummaryList' => [ 'shape' => 'TemplateVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateSummaryList' => [ 'shape' => 'TemplateSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListThemeAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-result', ], ], ], 'ListThemeAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAliasList' => [ 'shape' => 'ThemeAliasList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListThemeVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListThemeVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeVersionSummaryList' => [ 'shape' => 'ThemeVersionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListThemesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Type' => [ 'shape' => 'ThemeType', 'location' => 'querystring', 'locationName' => 'type', ], ], ], 'ListThemesResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeSummaryList' => [ 'shape' => 'ThemeSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicRefreshSchedulesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'ListTopicRefreshSchedulesResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'RefreshSchedules' => [ 'shape' => 'TopicRefreshScheduleSummaries', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicReviewedAnswersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], ], ], 'ListTopicReviewedAnswersResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Answers' => [ 'shape' => 'TopicReviewedAnswers', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'ListTopicsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListTopicsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicsSummaries' => [ 'shape' => 'TopicSummaries', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListUserGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListUserGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'UserList' => [ 'shape' => 'UserList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'ListVPCConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], ], ], 'ListVPCConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionSummaries' => [ 'shape' => 'VPCConnectionSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'LoadingAnimation' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'LocalNavigationConfiguration' => [ 'type' => 'structure', 'required' => [ 'TargetSheetId', ], 'members' => [ 'TargetSheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], ], ], 'LogicalTable' => [ 'type' => 'structure', 'required' => [ 'Alias', 'Source', ], 'members' => [ 'Alias' => [ 'shape' => 'LogicalTableAlias', ], 'DataTransforms' => [ 'shape' => 'TransformOperationList', ], 'Source' => [ 'shape' => 'LogicalTableSource', ], ], ], 'LogicalTableAlias' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'LogicalTableId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9a-zA-Z-]*', ], 'LogicalTableMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogicalTableId', ], 'value' => [ 'shape' => 'LogicalTable', ], 'max' => 64, 'min' => 1, ], 'LogicalTableSource' => [ 'type' => 'structure', 'members' => [ 'JoinInstruction' => [ 'shape' => 'JoinInstruction', ], 'PhysicalTableId' => [ 'shape' => 'PhysicalTableId', ], 'DataSetArn' => [ 'shape' => 'Arn', ], ], ], 'Long' => [ 'type' => 'long', ], 'LongFormatText' => [ 'type' => 'structure', 'members' => [ 'PlainText' => [ 'shape' => 'LongPlainText', ], 'RichText' => [ 'shape' => 'LongRichText', ], ], ], 'LongPlainText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'LongRichText' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'Longitude' => [ 'type' => 'double', 'max' => 1800, 'min' => -1800, ], 'LookbackWindow' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'Size', 'SizeUnit', ], 'members' => [ 'ColumnName' => [ 'shape' => 'String', ], 'Size' => [ 'shape' => 'PositiveLong', ], 'SizeUnit' => [ 'shape' => 'LookbackWindowSizeUnit', ], ], ], 'LookbackWindowSizeUnit' => [ 'type' => 'string', 'enum' => [ 'HOUR', 'DAY', 'WEEK', ], ], 'ManifestFileLocation' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'S3Bucket', ], 'Key' => [ 'shape' => 'S3Key', ], ], ], 'MapZoomMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'MANUAL', ], ], 'MappedDataSetParameter' => [ 'type' => 'structure', 'required' => [ 'DataSetIdentifier', 'DataSetParameterName', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'DataSetParameterName' => [ 'shape' => 'ParameterName', ], ], ], 'MappedDataSetParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'MappedDataSetParameter', ], 'max' => 150, 'min' => 0, ], 'MarginStyle' => [ 'type' => 'structure', 'members' => [ 'Show' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'MariaDbParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaximumLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'MaximumMinimumComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'Type' => [ 'shape' => 'MaximumMinimumComputationType', ], ], ], 'MaximumMinimumComputationType' => [ 'type' => 'string', 'enum' => [ 'MAXIMUM', 'MINIMUM', ], ], 'MeasureField' => [ 'type' => 'structure', 'members' => [ 'NumericalMeasureField' => [ 'shape' => 'NumericalMeasureField', ], 'CategoricalMeasureField' => [ 'shape' => 'CategoricalMeasureField', ], 'DateMeasureField' => [ 'shape' => 'DateMeasureField', ], 'CalculatedMeasureField' => [ 'shape' => 'CalculatedMeasureField', ], ], ], 'MeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 200, ], 'MemberIdArnPair' => [ 'type' => 'structure', 'members' => [ 'MemberId' => [ 'shape' => 'RestrictiveResourceId', ], 'MemberArn' => [ 'shape' => 'Arn', ], ], ], 'MemberType' => [ 'type' => 'string', 'enum' => [ 'DASHBOARD', 'ANALYSIS', 'DATASET', 'DATASOURCE', 'TOPIC', ], ], 'MetricComparisonComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'FromValue' => [ 'shape' => 'MeasureField', ], 'TargetValue' => [ 'shape' => 'MeasureField', ], ], ], 'MinimumLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'MissingDataConfiguration' => [ 'type' => 'structure', 'members' => [ 'TreatmentOption' => [ 'shape' => 'MissingDataTreatmentOption', ], ], ], 'MissingDataConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MissingDataConfiguration', ], 'max' => 100, ], 'MissingDataTreatmentOption' => [ 'type' => 'string', 'enum' => [ 'INTERPOLATE', 'SHOW_AS_ZERO', 'SHOW_AS_BLANK', ], ], 'MySqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'NamedEntityAggType' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MIN', 'MAX', 'COUNT', 'AVERAGE', 'DISTINCT_COUNT', 'STDEV', 'STDEVP', 'VAR', 'VARP', 'PERCENTILE', 'MEDIAN', 'CUSTOM', ], ], 'NamedEntityDefinition' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'LimitedString', ], 'PropertyName' => [ 'shape' => 'LimitedString', ], 'PropertyRole' => [ 'shape' => 'PropertyRole', ], 'PropertyUsage' => [ 'shape' => 'PropertyUsage', ], 'Metric' => [ 'shape' => 'NamedEntityDefinitionMetric', ], ], ], 'NamedEntityDefinitionMetric' => [ 'type' => 'structure', 'members' => [ 'Aggregation' => [ 'shape' => 'NamedEntityAggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggregationFunctionParameters', ], ], ], 'NamedEntityDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'NamedEntityDefinition', ], ], 'NamedEntityRef' => [ 'type' => 'structure', 'members' => [ 'NamedEntityName' => [ 'shape' => 'LimitedString', ], ], ], 'NamedFilterAggType' => [ 'type' => 'string', 'enum' => [ 'NO_AGGREGATION', 'SUM', 'AVERAGE', 'COUNT', 'DISTINCT_COUNT', 'MAX', 'MEDIAN', 'MIN', 'STDEV', 'STDEVP', 'VAR', 'VARP', ], ], 'NamedFilterType' => [ 'type' => 'string', 'enum' => [ 'CATEGORY_FILTER', 'NUMERIC_EQUALITY_FILTER', 'NUMERIC_RANGE_FILTER', 'DATE_RANGE_FILTER', 'RELATIVE_DATE_FILTER', ], ], 'Namespace' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[a-zA-Z0-9._-]*$', ], 'NamespaceError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'NamespaceErrorType', ], 'Message' => [ 'shape' => 'String', ], ], ], 'NamespaceErrorType' => [ 'type' => 'string', 'enum' => [ 'PERMISSION_DENIED', 'INTERNAL_SERVICE_ERROR', ], ], 'NamespaceInfoV2' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'Namespace', ], 'Arn' => [ 'shape' => 'Arn', ], 'CapacityRegion' => [ 'shape' => 'String', ], 'CreationStatus' => [ 'shape' => 'NamespaceStatus', ], 'IdentityStore' => [ 'shape' => 'IdentityStore', ], 'NamespaceError' => [ 'shape' => 'NamespaceError', ], ], ], 'NamespaceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'CREATING', 'DELETING', 'RETRYABLE_FAILURE', 'NON_RETRYABLE_FAILURE', ], ], 'Namespaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NamespaceInfoV2', ], ], 'NarrativeString' => [ 'type' => 'string', 'max' => 150000, ], 'NegativeFormat' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'LimitedString', ], 'Suffix' => [ 'shape' => 'LimitedString', ], ], ], 'NegativeValueConfiguration' => [ 'type' => 'structure', 'required' => [ 'DisplayMode', ], 'members' => [ 'DisplayMode' => [ 'shape' => 'NegativeValueDisplayMode', ], ], ], 'NegativeValueDisplayMode' => [ 'type' => 'string', 'enum' => [ 'POSITIVE', 'NEGATIVE', ], ], 'NestedFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'IncludeInnerSet', 'InnerFilter', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeInnerSet' => [ 'shape' => 'Boolean', ], 'InnerFilter' => [ 'shape' => 'InnerFilter', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'SubnetId' => [ 'shape' => 'SubnetId', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'NetworkInterfaceStatus', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^eni-[0-9a-z]*$', ], 'NetworkInterfaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkInterfaceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'AVAILABLE', 'CREATION_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETED', 'DELETION_FAILED', 'DELETION_SCHEDULED', 'ATTACHMENT_FAILED_ROLLBACK_FAILED', ], ], 'NewDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StringStaticValues' => [ 'shape' => 'StringDatasetParameterValueList', ], 'DecimalStaticValues' => [ 'shape' => 'DecimalDatasetParameterValueList', ], 'DateTimeStaticValues' => [ 'shape' => 'DateTimeDatasetParameterValueList', ], 'IntegerStaticValues' => [ 'shape' => 'IntegerDatasetParameterValueList', ], ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NonRepeatingVisualsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 20, ], 'NullFilterOption' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', 'NON_NULLS_ONLY', 'NULLS_ONLY', ], ], 'NullString' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'NullValueFormatConfiguration' => [ 'type' => 'structure', 'required' => [ 'NullString', ], 'members' => [ 'NullString' => [ 'shape' => 'NullString', ], ], ], 'NullableBoolean' => [ 'type' => 'boolean', ], 'NumberDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NumberScale' => [ 'shape' => 'NumberScale', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'NumberFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'FormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'NumberScale' => [ 'type' => 'string', 'enum' => [ 'NONE', 'AUTO', 'THOUSANDS', 'MILLIONS', 'BILLIONS', 'TRILLIONS', ], ], 'NumericAxisOptions' => [ 'type' => 'structure', 'members' => [ 'Scale' => [ 'shape' => 'AxisScale', ], 'Range' => [ 'shape' => 'AxisDisplayRange', ], ], ], 'NumericEqualityDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'Value', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'NumericEqualityFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'MatchOperator', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Double', 'box' => true, ], 'SelectAllOptions' => [ 'shape' => 'NumericFilterSelectAllOptions', ], 'MatchOperator' => [ 'shape' => 'NumericEqualityMatchOperator', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'NumericEqualityMatchOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'DOES_NOT_EQUAL', ], ], 'NumericFilterSelectAllOptions' => [ 'type' => 'string', 'enum' => [ 'FILTER_ALL_VALUES', ], ], 'NumericFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NumberDisplayFormatConfiguration' => [ 'shape' => 'NumberDisplayFormatConfiguration', ], 'CurrencyDisplayFormatConfiguration' => [ 'shape' => 'CurrencyDisplayFormatConfiguration', ], 'PercentageDisplayFormatConfiguration' => [ 'shape' => 'PercentageDisplayFormatConfiguration', ], ], ], 'NumericRangeFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeMinimum' => [ 'shape' => 'Boolean', 'box' => true, ], 'IncludeMaximum' => [ 'shape' => 'Boolean', 'box' => true, ], 'RangeMinimum' => [ 'shape' => 'NumericRangeFilterValue', 'box' => true, ], 'RangeMaximum' => [ 'shape' => 'NumericRangeFilterValue', 'box' => true, ], 'SelectAllOptions' => [ 'shape' => 'NumericFilterSelectAllOptions', ], 'AggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'NumericRangeFilterValue' => [ 'type' => 'structure', 'members' => [ 'StaticValue' => [ 'shape' => 'Double', 'box' => true, ], 'Parameter' => [ 'shape' => 'ParameterName', ], ], ], 'NumericSeparatorConfiguration' => [ 'type' => 'structure', 'members' => [ 'DecimalSeparator' => [ 'shape' => 'NumericSeparatorSymbol', ], 'ThousandsSeparator' => [ 'shape' => 'ThousandSeparatorOptions', ], ], ], 'NumericSeparatorSymbol' => [ 'type' => 'string', 'enum' => [ 'COMMA', 'DOT', 'SPACE', ], ], 'NumericalAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleNumericalAggregation' => [ 'shape' => 'SimpleNumericalAggregationFunction', ], 'PercentileAggregation' => [ 'shape' => 'PercentileAggregation', ], ], ], 'NumericalDimensionField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'FormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], ], ], 'NumericalMeasureField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AggregationFunction' => [ 'shape' => 'NumericalAggregationFunction', ], 'FormatConfiguration' => [ 'shape' => 'NumberFormatConfiguration', ], ], ], 'OnClause' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'OperandList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Identifier', ], 'max' => 25, ], 'OptionalPort' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'OracleParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'OtherCategories' => [ 'type' => 'string', 'enum' => [ 'INCLUDE', 'EXCLUDE', ], ], 'OutputColumn' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ColumnName', ], 'Description' => [ 'shape' => 'ColumnDescriptiveText', ], 'Type' => [ 'shape' => 'ColumnDataType', ], 'SubType' => [ 'shape' => 'ColumnDataSubType', ], ], ], 'OutputColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputColumn', ], ], 'OverrideDatasetParameterOperation' => [ 'type' => 'structure', 'required' => [ 'ParameterName', ], 'members' => [ 'ParameterName' => [ 'shape' => 'DatasetParameterName', ], 'NewParameterName' => [ 'shape' => 'DatasetParameterName', ], 'NewDefaultValues' => [ 'shape' => 'NewDefaultValues', ], ], ], 'PageNumber' => [ 'type' => 'long', 'min' => 0, ], 'PaginationConfiguration' => [ 'type' => 'structure', 'required' => [ 'PageSize', 'PageNumber', ], 'members' => [ 'PageSize' => [ 'shape' => 'Long', 'box' => true, ], 'PageNumber' => [ 'shape' => 'PageNumber', ], ], ], 'PanelBorderStyle' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DASHED', 'DOTTED', ], ], 'PanelConfiguration' => [ 'type' => 'structure', 'members' => [ 'Title' => [ 'shape' => 'PanelTitleOptions', ], 'BorderVisibility' => [ 'shape' => 'Visibility', ], 'BorderThickness' => [ 'shape' => 'PixelLength', ], 'BorderStyle' => [ 'shape' => 'PanelBorderStyle', ], 'BorderColor' => [ 'shape' => 'HexColorWithTransparency', ], 'GutterVisibility' => [ 'shape' => 'Visibility', ], 'GutterSpacing' => [ 'shape' => 'PixelLength', ], 'BackgroundVisibility' => [ 'shape' => 'Visibility', ], 'BackgroundColor' => [ 'shape' => 'HexColorWithTransparency', ], ], ], 'PanelTitleOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'HorizontalTextAlignment' => [ 'shape' => 'HorizontalTextAlignment', ], ], ], 'PaperOrientation' => [ 'type' => 'string', 'enum' => [ 'PORTRAIT', 'LANDSCAPE', ], ], 'PaperSize' => [ 'type' => 'string', 'enum' => [ 'US_LETTER', 'US_LEGAL', 'US_TABLOID_LEDGER', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'JIS_B4', 'JIS_B5', ], ], 'ParameterControl' => [ 'type' => 'structure', 'members' => [ 'DateTimePicker' => [ 'shape' => 'ParameterDateTimePickerControl', ], 'List' => [ 'shape' => 'ParameterListControl', ], 'Dropdown' => [ 'shape' => 'ParameterDropDownControl', ], 'TextField' => [ 'shape' => 'ParameterTextFieldControl', ], 'TextArea' => [ 'shape' => 'ParameterTextAreaControl', ], 'Slider' => [ 'shape' => 'ParameterSliderControl', ], ], ], 'ParameterControlList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterControl', ], 'max' => 200, ], 'ParameterDateTimePickerControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'DateTimePickerControlDisplayOptions', ], ], ], 'ParameterDeclaration' => [ 'type' => 'structure', 'members' => [ 'StringParameterDeclaration' => [ 'shape' => 'StringParameterDeclaration', ], 'DecimalParameterDeclaration' => [ 'shape' => 'DecimalParameterDeclaration', ], 'IntegerParameterDeclaration' => [ 'shape' => 'IntegerParameterDeclaration', ], 'DateTimeParameterDeclaration' => [ 'shape' => 'DateTimeParameterDeclaration', ], ], ], 'ParameterDeclarationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterDeclaration', ], 'max' => 200, ], 'ParameterDropDownControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'DropDownControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'ParameterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'ParameterListControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'ListControlDisplayOptions', ], 'Type' => [ 'shape' => 'SheetControlListType', ], 'SelectableValues' => [ 'shape' => 'ParameterSelectableValues', ], 'CascadingControlConfiguration' => [ 'shape' => 'CascadingControlConfiguration', ], ], ], 'ParameterName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]+$', ], 'ParameterSelectableValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 50000, ], 'ParameterSelectableValues' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'ParameterSelectableValueList', ], 'LinkToDataSetColumn' => [ 'shape' => 'ColumnIdentifier', ], ], ], 'ParameterSliderControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', 'MaximumValue', 'MinimumValue', 'StepSize', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'SliderControlDisplayOptions', ], 'MaximumValue' => [ 'shape' => 'Double', ], 'MinimumValue' => [ 'shape' => 'Double', ], 'StepSize' => [ 'shape' => 'Double', ], ], ], 'ParameterTextAreaControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'Delimiter' => [ 'shape' => 'TextAreaControlDelimiter', ], 'DisplayOptions' => [ 'shape' => 'TextAreaControlDisplayOptions', ], ], ], 'ParameterTextFieldControl' => [ 'type' => 'structure', 'required' => [ 'ParameterControlId', 'Title', 'SourceParameterName', ], 'members' => [ 'ParameterControlId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetControlTitle', ], 'SourceParameterName' => [ 'shape' => 'ParameterName', ], 'DisplayOptions' => [ 'shape' => 'TextFieldControlDisplayOptions', ], ], ], 'ParameterValueType' => [ 'type' => 'string', 'enum' => [ 'MULTI_VALUED', 'SINGLE_VALUED', ], ], 'Parameters' => [ 'type' => 'structure', 'members' => [ 'StringParameters' => [ 'shape' => 'StringParameterList', ], 'IntegerParameters' => [ 'shape' => 'IntegerParameterList', ], 'DecimalParameters' => [ 'shape' => 'DecimalParameterList', ], 'DateTimeParameters' => [ 'shape' => 'DateTimeParameterList', ], ], ], 'Password' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'Path' => [ 'type' => 'list', 'member' => [ 'shape' => 'Arn', ], 'max' => 10, 'min' => 1, ], 'PercentNumber' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'PercentVisibleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'PercentNumber', 'box' => true, ], 'To' => [ 'shape' => 'PercentNumber', 'box' => true, ], ], ], 'PercentageDisplayFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Suffix' => [ 'shape' => 'Suffix', ], 'SeparatorConfiguration' => [ 'shape' => 'NumericSeparatorConfiguration', ], 'DecimalPlacesConfiguration' => [ 'shape' => 'DecimalPlacesConfiguration', ], 'NegativeValueConfiguration' => [ 'shape' => 'NegativeValueConfiguration', ], 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], ], ], 'PercentileAggregation' => [ 'type' => 'structure', 'members' => [ 'PercentileValue' => [ 'shape' => 'PercentileValue', ], ], ], 'PercentileValue' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'PeriodOverPeriodComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], ], ], 'PeriodToDateComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'PeriodTimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'PeriodsBackward' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'PeriodsForward' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'PhysicalTable' => [ 'type' => 'structure', 'members' => [ 'RelationalTable' => [ 'shape' => 'RelationalTable', ], 'CustomSql' => [ 'shape' => 'CustomSql', ], 'S3Source' => [ 'shape' => 'S3Source', ], ], ], 'PhysicalTableId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[0-9a-zA-Z-]*', ], 'PhysicalTableMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PhysicalTableId', ], 'value' => [ 'shape' => 'PhysicalTable', ], 'max' => 32, 'min' => 0, ], 'PieChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'SmallMultiples' => [ 'shape' => 'SmallMultiplesDimensionFieldList', ], ], ], 'PieChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'PieChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'PieChartSortConfiguration', ], 'DonutOptions' => [ 'shape' => 'DonutOptions', ], 'SmallMultiplesOptions' => [ 'shape' => 'SmallMultiplesOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ValueLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ContributionAnalysisDefaults' => [ 'shape' => 'ContributionAnalysisDefaultList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'PieChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'PieChartAggregatedFieldWells' => [ 'shape' => 'PieChartAggregatedFieldWells', ], ], ], 'PieChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'SmallMultiplesSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SmallMultiplesLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'PieChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'PieChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'PivotFieldSortOptions' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'SortBy', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'SortBy' => [ 'shape' => 'PivotTableSortBy', ], ], ], 'PivotFieldSortOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotFieldSortOptions', ], 'max' => 200, ], 'PivotMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 40, ], 'PivotTableAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Rows' => [ 'shape' => 'PivotTableDimensionList', ], 'Columns' => [ 'shape' => 'PivotTableDimensionList', ], 'Values' => [ 'shape' => 'PivotMeasureFieldList', ], ], ], 'PivotTableCellConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TextFormat' => [ 'shape' => 'TextConditionalFormat', ], 'Scope' => [ 'shape' => 'PivotTableConditionalFormattingScope', ], 'Scopes' => [ 'shape' => 'PivotTableConditionalFormattingScopeList', ], ], ], 'PivotTableConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'PivotTableConditionalFormattingOptionList', ], ], ], 'PivotTableConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'Cell' => [ 'shape' => 'PivotTableCellConditionalFormatting', ], ], ], 'PivotTableConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableConditionalFormattingOption', ], 'max' => 500, ], 'PivotTableConditionalFormattingScope' => [ 'type' => 'structure', 'members' => [ 'Role' => [ 'shape' => 'PivotTableConditionalFormattingScopeRole', ], ], ], 'PivotTableConditionalFormattingScopeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableConditionalFormattingScope', ], 'max' => 3, ], 'PivotTableConditionalFormattingScopeRole' => [ 'type' => 'string', 'enum' => [ 'FIELD', 'FIELD_TOTAL', 'GRAND_TOTAL', ], ], 'PivotTableConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'PivotTableFieldWells', ], 'SortConfiguration' => [ 'shape' => 'PivotTableSortConfiguration', ], 'TableOptions' => [ 'shape' => 'PivotTableOptions', ], 'TotalOptions' => [ 'shape' => 'PivotTableTotalOptions', ], 'FieldOptions' => [ 'shape' => 'PivotTableFieldOptions', ], 'PaginatedReportOptions' => [ 'shape' => 'PivotTablePaginatedReportOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'PivotTableDataPathOption' => [ 'type' => 'structure', 'required' => [ 'DataPathList', ], 'members' => [ 'DataPathList' => [ 'shape' => 'DataPathValueList', ], 'Width' => [ 'shape' => 'PixelLength', ], ], ], 'PivotTableDataPathOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableDataPathOption', ], 'max' => 100, ], 'PivotTableDataPathType' => [ 'type' => 'string', 'enum' => [ 'HIERARCHY_ROWS_LAYOUT_COLUMN', 'MULTIPLE_ROW_METRICS_COLUMN', 'EMPTY_COLUMN_HEADER', 'COUNT_METRIC_COLUMN', ], ], 'PivotTableDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 40, ], 'PivotTableFieldCollapseState' => [ 'type' => 'string', 'enum' => [ 'COLLAPSED', 'EXPANDED', ], ], 'PivotTableFieldCollapseStateOption' => [ 'type' => 'structure', 'required' => [ 'Target', ], 'members' => [ 'Target' => [ 'shape' => 'PivotTableFieldCollapseStateTarget', ], 'State' => [ 'shape' => 'PivotTableFieldCollapseState', ], ], ], 'PivotTableFieldCollapseStateOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldCollapseStateOption', ], ], 'PivotTableFieldCollapseStateTarget' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'String', ], 'FieldDataPathValues' => [ 'shape' => 'DataPathValueList', ], ], ], 'PivotTableFieldOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'CustomLabel' => [ 'shape' => 'CustomLabel', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'PivotTableFieldOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldOption', ], 'max' => 100, ], 'PivotTableFieldOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedFieldOptions' => [ 'shape' => 'PivotTableFieldOptionList', ], 'DataPathOptions' => [ 'shape' => 'PivotTableDataPathOptionList', ], 'CollapseStateOptions' => [ 'shape' => 'PivotTableFieldCollapseStateOptionList', ], ], ], 'PivotTableFieldSubtotalOptions' => [ 'type' => 'structure', 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], ], ], 'PivotTableFieldSubtotalOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PivotTableFieldSubtotalOptions', ], 'max' => 100, ], 'PivotTableFieldWells' => [ 'type' => 'structure', 'members' => [ 'PivotTableAggregatedFieldWells' => [ 'shape' => 'PivotTableAggregatedFieldWells', ], ], ], 'PivotTableMetricPlacement' => [ 'type' => 'string', 'enum' => [ 'ROW', 'COLUMN', ], ], 'PivotTableOptions' => [ 'type' => 'structure', 'members' => [ 'MetricPlacement' => [ 'shape' => 'PivotTableMetricPlacement', ], 'SingleMetricVisibility' => [ 'shape' => 'Visibility', ], 'ColumnNamesVisibility' => [ 'shape' => 'Visibility', ], 'ToggleButtonsVisibility' => [ 'shape' => 'Visibility', ], 'ColumnHeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'RowHeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'CellStyle' => [ 'shape' => 'TableCellStyle', ], 'RowFieldNamesStyle' => [ 'shape' => 'TableCellStyle', ], 'RowAlternateColorOptions' => [ 'shape' => 'RowAlternateColorOptions', ], 'CollapsedRowDimensionsVisibility' => [ 'shape' => 'Visibility', ], 'RowsLayout' => [ 'shape' => 'PivotTableRowsLayout', ], 'RowsLabelOptions' => [ 'shape' => 'PivotTableRowsLabelOptions', ], 'DefaultCellWidth' => [ 'shape' => 'PixelLength', ], ], ], 'PivotTablePaginatedReportOptions' => [ 'type' => 'structure', 'members' => [ 'VerticalOverflowVisibility' => [ 'shape' => 'Visibility', ], 'OverflowColumnHeaderVisibility' => [ 'shape' => 'Visibility', ], ], ], 'PivotTableRowsLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'CustomLabel' => [ 'shape' => 'PivotTableRowsLabelText', ], ], ], 'PivotTableRowsLabelText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'PivotTableRowsLayout' => [ 'type' => 'string', 'enum' => [ 'TABULAR', 'HIERARCHY', ], ], 'PivotTableSortBy' => [ 'type' => 'structure', 'members' => [ 'Field' => [ 'shape' => 'FieldSort', ], 'Column' => [ 'shape' => 'ColumnSort', ], 'DataPath' => [ 'shape' => 'DataPathSort', ], ], ], 'PivotTableSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldSortOptions' => [ 'shape' => 'PivotFieldSortOptionsList', ], ], ], 'PivotTableSubtotalLevel' => [ 'type' => 'string', 'enum' => [ 'ALL', 'CUSTOM', 'LAST', ], ], 'PivotTableTotalOptions' => [ 'type' => 'structure', 'members' => [ 'RowSubtotalOptions' => [ 'shape' => 'SubtotalOptions', ], 'ColumnSubtotalOptions' => [ 'shape' => 'SubtotalOptions', ], 'RowTotalOptions' => [ 'shape' => 'PivotTotalOptions', ], 'ColumnTotalOptions' => [ 'shape' => 'PivotTotalOptions', ], ], ], 'PivotTableVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'PivotTableConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'PivotTableConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'PivotTotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'Placement' => [ 'shape' => 'TableTotalsPlacement', ], 'ScrollStatus' => [ 'shape' => 'TableTotalsScrollStatus', ], 'CustomLabel' => [ 'shape' => 'String', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'ValueCellStyle' => [ 'shape' => 'TableCellStyle', ], 'MetricHeaderCellStyle' => [ 'shape' => 'TableCellStyle', ], 'TotalAggregationOptions' => [ 'shape' => 'TotalAggregationOptionList', ], ], ], 'PixelLength' => [ 'type' => 'string', ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 1, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'PostgreSqlParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'PreconditionNotMetException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'PredefinedHierarchy' => [ 'type' => 'structure', 'required' => [ 'HierarchyId', 'Columns', ], 'members' => [ 'HierarchyId' => [ 'shape' => 'HierarchyId', ], 'Columns' => [ 'shape' => 'PredefinedHierarchyColumnList', ], 'DrillDownFilters' => [ 'shape' => 'DrillDownFilterList', ], ], ], 'PredefinedHierarchyColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ColumnIdentifier', ], 'max' => 10, 'min' => 1, ], 'PredictionInterval' => [ 'type' => 'integer', 'max' => 95, 'min' => 50, ], 'Prefix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'PrestoParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], ], ], 'PrimaryValueDisplayType' => [ 'type' => 'string', 'enum' => [ 'HIDDEN', 'COMPARISON', 'ACTUAL', ], ], 'Principal' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 100, 'min' => 1, ], 'ProgressBarOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ProjectId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ProjectOperation' => [ 'type' => 'structure', 'required' => [ 'ProjectedColumns', ], 'members' => [ 'ProjectedColumns' => [ 'shape' => 'ProjectedColumnList', ], ], ], 'ProjectedColumnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 2000, 'min' => 1, ], 'PropertyRole' => [ 'type' => 'string', 'enum' => [ 'PRIMARY', 'ID', ], ], 'PropertyUsage' => [ 'type' => 'string', 'enum' => [ 'INHERIT', 'DIMENSION', 'MEASURE', ], ], 'PurchaseMode' => [ 'type' => 'string', 'enum' => [ 'MANUAL', 'AUTO_PURCHASE', ], ], 'PutDataSetRefreshPropertiesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'DataSetRefreshProperties', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'DataSetRefreshProperties' => [ 'shape' => 'DataSetRefreshProperties', ], ], ], 'PutDataSetRefreshPropertiesResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Query' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'QueryExecutionMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'MANUAL', ], ], 'QueryExecutionOptions' => [ 'type' => 'structure', 'members' => [ 'QueryExecutionMode' => [ 'shape' => 'QueryExecutionMode', ], ], ], 'QueueInfo' => [ 'type' => 'structure', 'required' => [ 'WaitingOnIngestion', 'QueuedIngestion', ], 'members' => [ 'WaitingOnIngestion' => [ 'shape' => 'String', ], 'QueuedIngestion' => [ 'shape' => 'String', ], ], ], 'QuickSightUserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RadarChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Category' => [ 'shape' => 'RadarChartCategoryFieldList', ], 'Color' => [ 'shape' => 'RadarChartColorFieldList', ], 'Values' => [ 'shape' => 'RadarChartValuesFieldList', ], ], ], 'RadarChartAreaStyleSettings' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'RadarChartAxesRangeScale' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'INDEPENDENT', 'SHARED', ], ], 'RadarChartCategoryFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'RadarChartColorFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'RadarChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'RadarChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'RadarChartSortConfiguration', ], 'Shape' => [ 'shape' => 'RadarChartShape', ], 'BaseSeriesSettings' => [ 'shape' => 'RadarChartSeriesSettings', ], 'StartAngle' => [ 'shape' => 'RadarChartStartAngle', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'AlternateBandColorsVisibility' => [ 'shape' => 'Visibility', ], 'AlternateBandEvenColor' => [ 'shape' => 'HexColor', ], 'AlternateBandOddColor' => [ 'shape' => 'HexColor', ], 'CategoryAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorAxis' => [ 'shape' => 'AxisDisplayOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'AxesRangeScale' => [ 'shape' => 'RadarChartAxesRangeScale', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'RadarChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'RadarChartAggregatedFieldWells' => [ 'shape' => 'RadarChartAggregatedFieldWells', ], ], ], 'RadarChartSeriesSettings' => [ 'type' => 'structure', 'members' => [ 'AreaStyleSettings' => [ 'shape' => 'RadarChartAreaStyleSettings', ], ], ], 'RadarChartShape' => [ 'type' => 'string', 'enum' => [ 'CIRCLE', 'POLYGON', ], ], 'RadarChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'ColorSort' => [ 'shape' => 'FieldSortOptionsList', ], 'ColorItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'RadarChartStartAngle' => [ 'type' => 'double', 'max' => 360, 'min' => -360, ], 'RadarChartValuesFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 20, ], 'RadarChartVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'RadarChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'RangeConstant' => [ 'type' => 'structure', 'members' => [ 'Minimum' => [ 'shape' => 'LimitedString', ], 'Maximum' => [ 'shape' => 'LimitedString', ], ], ], 'RangeEndsLabelType' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'RdsParameters' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Database', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'RecoveryWindowInDays' => [ 'type' => 'long', 'max' => 30, 'min' => 7, ], 'RedshiftIAMParameters' => [ 'type' => 'structure', 'required' => [ 'RoleArn', ], 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], 'DatabaseUser' => [ 'shape' => 'DatabaseUser', ], 'DatabaseGroups' => [ 'shape' => 'DatabaseGroupList', ], 'AutoCreateDatabaseUser' => [ 'shape' => 'Boolean', ], ], ], 'RedshiftParameters' => [ 'type' => 'structure', 'required' => [ 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'OptionalPort', ], 'Database' => [ 'shape' => 'Database', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'IAMParameters' => [ 'shape' => 'RedshiftIAMParameters', ], 'IdentityCenterConfiguration' => [ 'shape' => 'IdentityCenterConfiguration', ], ], ], 'ReferenceLine' => [ 'type' => 'structure', 'required' => [ 'DataConfiguration', ], 'members' => [ 'Status' => [ 'shape' => 'WidgetStatus', ], 'DataConfiguration' => [ 'shape' => 'ReferenceLineDataConfiguration', ], 'StyleConfiguration' => [ 'shape' => 'ReferenceLineStyleConfiguration', ], 'LabelConfiguration' => [ 'shape' => 'ReferenceLineLabelConfiguration', ], ], ], 'ReferenceLineCustomLabelConfiguration' => [ 'type' => 'structure', 'required' => [ 'CustomLabel', ], 'members' => [ 'CustomLabel' => [ 'shape' => 'NonEmptyString', ], ], ], 'ReferenceLineDataConfiguration' => [ 'type' => 'structure', 'members' => [ 'StaticConfiguration' => [ 'shape' => 'ReferenceLineStaticDataConfiguration', ], 'DynamicConfiguration' => [ 'shape' => 'ReferenceLineDynamicDataConfiguration', ], 'AxisBinding' => [ 'shape' => 'AxisBinding', ], 'SeriesType' => [ 'shape' => 'ReferenceLineSeriesType', ], ], ], 'ReferenceLineDynamicDataConfiguration' => [ 'type' => 'structure', 'required' => [ 'Column', 'Calculation', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'MeasureAggregationFunction' => [ 'shape' => 'AggregationFunction', ], 'Calculation' => [ 'shape' => 'NumericalAggregationFunction', ], ], ], 'ReferenceLineLabelConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueLabelConfiguration' => [ 'shape' => 'ReferenceLineValueLabelConfiguration', ], 'CustomLabelConfiguration' => [ 'shape' => 'ReferenceLineCustomLabelConfiguration', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'FontColor' => [ 'shape' => 'HexColor', ], 'HorizontalPosition' => [ 'shape' => 'ReferenceLineLabelHorizontalPosition', ], 'VerticalPosition' => [ 'shape' => 'ReferenceLineLabelVerticalPosition', ], ], ], 'ReferenceLineLabelHorizontalPosition' => [ 'type' => 'string', 'enum' => [ 'LEFT', 'CENTER', 'RIGHT', ], ], 'ReferenceLineLabelVerticalPosition' => [ 'type' => 'string', 'enum' => [ 'ABOVE', 'BELOW', ], ], 'ReferenceLineList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceLine', ], 'max' => 20, ], 'ReferenceLinePatternType' => [ 'type' => 'string', 'enum' => [ 'SOLID', 'DASHED', 'DOTTED', ], ], 'ReferenceLineSeriesType' => [ 'type' => 'string', 'enum' => [ 'BAR', 'LINE', ], ], 'ReferenceLineStaticDataConfiguration' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'Value' => [ 'shape' => 'SensitiveDouble', ], ], ], 'ReferenceLineStyleConfiguration' => [ 'type' => 'structure', 'members' => [ 'Pattern' => [ 'shape' => 'ReferenceLinePatternType', ], 'Color' => [ 'shape' => 'HexColor', ], ], ], 'ReferenceLineValueLabelConfiguration' => [ 'type' => 'structure', 'members' => [ 'RelativePosition' => [ 'shape' => 'ReferenceLineValueLabelRelativePosition', ], 'FormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'ReferenceLineValueLabelRelativePosition' => [ 'type' => 'string', 'enum' => [ 'BEFORE_CUSTOM_LABEL', 'AFTER_CUSTOM_LABEL', ], ], 'RefreshConfiguration' => [ 'type' => 'structure', 'required' => [ 'IncrementalRefresh', ], 'members' => [ 'IncrementalRefresh' => [ 'shape' => 'IncrementalRefresh', ], ], ], 'RefreshFrequency' => [ 'type' => 'structure', 'required' => [ 'Interval', ], 'members' => [ 'Interval' => [ 'shape' => 'RefreshInterval', ], 'RefreshOnDay' => [ 'shape' => 'ScheduleRefreshOnEntity', ], 'Timezone' => [ 'shape' => 'String', ], 'TimeOfTheDay' => [ 'shape' => 'String', ], ], ], 'RefreshInterval' => [ 'type' => 'string', 'enum' => [ 'MINUTE15', 'MINUTE30', 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'RefreshSchedule' => [ 'type' => 'structure', 'required' => [ 'ScheduleId', 'ScheduleFrequency', 'RefreshType', ], 'members' => [ 'ScheduleId' => [ 'shape' => 'String', ], 'ScheduleFrequency' => [ 'shape' => 'RefreshFrequency', ], 'StartAfterDateTime' => [ 'shape' => 'Timestamp', ], 'RefreshType' => [ 'shape' => 'IngestionType', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'RefreshSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'RefreshSchedule', ], ], 'RegisterUserRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityType', 'Email', 'UserRole', 'AwsAccountId', 'Namespace', ], 'members' => [ 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Email' => [ 'shape' => 'String', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'IamArn' => [ 'shape' => 'String', ], 'SessionName' => [ 'shape' => 'RoleSessionName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'UserName' => [ 'shape' => 'UserName', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'CustomFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'UserInvitationUrl' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'RegisteredCustomerManagedKey' => [ 'type' => 'structure', 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'DefaultKey' => [ 'shape' => 'Boolean', ], ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardId', ], 'members' => [ 'InitialDashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserDashboardFeatureConfigurations', ], ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'type' => 'structure', 'members' => [ 'StatePersistence' => [ 'shape' => 'StatePersistenceConfigurations', ], 'SharedView' => [ 'shape' => 'SharedViewConfigurations', ], 'Bookmarks' => [ 'shape' => 'BookmarksConfigurations', ], ], ], 'RegisteredUserDashboardVisualEmbeddingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InitialDashboardVisualId', ], 'members' => [ 'InitialDashboardVisualId' => [ 'shape' => 'DashboardVisualId', ], ], ], 'RegisteredUserEmbeddingExperienceConfiguration' => [ 'type' => 'structure', 'members' => [ 'Dashboard' => [ 'shape' => 'RegisteredUserDashboardEmbeddingConfiguration', ], 'QuickSightConsole' => [ 'shape' => 'RegisteredUserQuickSightConsoleEmbeddingConfiguration', ], 'QSearchBar' => [ 'shape' => 'RegisteredUserQSearchBarEmbeddingConfiguration', ], 'DashboardVisual' => [ 'shape' => 'RegisteredUserDashboardVisualEmbeddingConfiguration', ], 'GenerativeQnA' => [ 'shape' => 'RegisteredUserGenerativeQnAEmbeddingConfiguration', ], ], ], 'RegisteredUserGenerativeQnAEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'RegisteredUserQSearchBarEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialTopicId' => [ 'shape' => 'RestrictiveResourceId', ], ], ], 'RegisteredUserQuickSightConsoleEmbeddingConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialPath' => [ 'shape' => 'EntryPath', ], 'FeatureConfigurations' => [ 'shape' => 'RegisteredUserConsoleFeatureConfigurations', ], ], ], 'RelationalTable' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'Name', 'InputColumns', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'Catalog' => [ 'shape' => 'RelationalTableCatalog', ], 'Schema' => [ 'shape' => 'RelationalTableSchema', ], 'Name' => [ 'shape' => 'RelationalTableName', ], 'InputColumns' => [ 'shape' => 'InputColumnList', ], ], ], 'RelationalTableCatalog' => [ 'type' => 'string', 'max' => 256, ], 'RelationalTableName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RelationalTableSchema' => [ 'type' => 'string', 'max' => 256, ], 'RelativeDateTimeControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'DateTimeFormat' => [ 'shape' => 'DateTimeFormat', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'RelativeDateType' => [ 'type' => 'string', 'enum' => [ 'PREVIOUS', 'THIS', 'LAST', 'NOW', 'NEXT', ], ], 'RelativeDatesFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'AnchorDateConfiguration', 'TimeGranularity', 'RelativeDateType', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'AnchorDateConfiguration' => [ 'shape' => 'AnchorDateConfiguration', ], 'MinimumGranularity' => [ 'shape' => 'TimeGranularity', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'RelativeDateType' => [ 'shape' => 'RelativeDateType', ], 'RelativeDateValue' => [ 'shape' => 'Integer', 'box' => true, ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'ExcludePeriodConfiguration' => [ 'shape' => 'ExcludePeriodConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'RelativeFontSize' => [ 'type' => 'string', 'enum' => [ 'EXTRA_SMALL', 'SMALL', 'MEDIUM', 'LARGE', 'EXTRA_LARGE', ], ], 'RenameColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'NewColumnName', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'NewColumnName' => [ 'shape' => 'ColumnName', ], ], ], 'ResizeOption' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'RESPONSIVE', ], ], 'ResourceExistsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', ], 'ResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePermission' => [ 'type' => 'structure', 'required' => [ 'Principal', 'Actions', ], 'members' => [ 'Principal' => [ 'shape' => 'Principal', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'ResourcePermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 64, 'min' => 1, ], 'ResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'CREATION_SUCCESSFUL', 'CREATION_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_FAILED', 'DELETED', ], ], 'ResourceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'ResourceType' => [ 'shape' => 'ExceptionResourceType', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, ], 'RestoreAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], ], ], 'RestoreAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'RestrictiveResourceId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ReviewedAnswerErrorCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'MISSING_ANSWER', 'DATASET_DOES_NOT_EXIST', 'INVALID_DATASET_ARN', 'DUPLICATED_ANSWER', 'INVALID_DATA', 'MISSING_REQUIRED_FIELDS', ], ], 'Role' => [ 'type' => 'string', 'enum' => [ 'ADMIN', 'AUTHOR', 'READER', 'ADMIN_PRO', 'AUTHOR_PRO', 'READER_PRO', ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'RoleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9+=,.@_-]+$', ], 'RoleSessionName' => [ 'type' => 'string', 'max' => 64, 'min' => 2, 'pattern' => '[\\w+=.@-]*', ], 'RollingDateConfiguration' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'DataSetIdentifier' => [ 'shape' => 'DataSetIdentifier', ], 'Expression' => [ 'shape' => 'Expression', ], ], ], 'RowAlternateColorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HexColor', ], 'max' => 1, ], 'RowAlternateColorOptions' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'WidgetStatus', ], 'RowAlternateColors' => [ 'shape' => 'RowAlternateColorList', ], 'UsePrimaryBackgroundColor' => [ 'shape' => 'WidgetStatus', ], ], ], 'RowInfo' => [ 'type' => 'structure', 'members' => [ 'RowsIngested' => [ 'shape' => 'Long', 'box' => true, ], 'RowsDropped' => [ 'shape' => 'Long', 'box' => true, ], 'TotalRowsInDataset' => [ 'shape' => 'Long', 'box' => true, ], ], ], 'RowLevelPermissionDataSet' => [ 'type' => 'structure', 'required' => [ 'Arn', 'PermissionPolicy', ], 'members' => [ 'Namespace' => [ 'shape' => 'Namespace', ], 'Arn' => [ 'shape' => 'Arn', ], 'PermissionPolicy' => [ 'shape' => 'RowLevelPermissionPolicy', ], 'FormatVersion' => [ 'shape' => 'RowLevelPermissionFormatVersion', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'RowLevelPermissionFormatVersion' => [ 'type' => 'string', 'enum' => [ 'VERSION_1', 'VERSION_2', ], ], 'RowLevelPermissionPolicy' => [ 'type' => 'string', 'enum' => [ 'GRANT_ACCESS', 'DENY_ACCESS', ], ], 'RowLevelPermissionTagConfiguration' => [ 'type' => 'structure', 'required' => [ 'TagRules', ], 'members' => [ 'Status' => [ 'shape' => 'Status', ], 'TagRules' => [ 'shape' => 'RowLevelPermissionTagRuleList', ], 'TagRuleConfigurations' => [ 'shape' => 'RowLevelPermissionTagRuleConfigurationList', ], ], ], 'RowLevelPermissionTagDelimiter' => [ 'type' => 'string', 'max' => 10, ], 'RowLevelPermissionTagRule' => [ 'type' => 'structure', 'required' => [ 'TagKey', 'ColumnName', ], 'members' => [ 'TagKey' => [ 'shape' => 'SessionTagKey', ], 'ColumnName' => [ 'shape' => 'String', ], 'TagMultiValueDelimiter' => [ 'shape' => 'RowLevelPermissionTagDelimiter', ], 'MatchAllValue' => [ 'shape' => 'SessionTagValue', ], ], ], 'RowLevelPermissionTagRuleConfiguration' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTagKey', ], 'max' => 50, 'min' => 1, ], 'RowLevelPermissionTagRuleConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RowLevelPermissionTagRuleConfiguration', ], 'max' => 50, 'min' => 1, ], 'RowLevelPermissionTagRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RowLevelPermissionTagRule', ], 'max' => 50, 'min' => 1, ], 'RowSortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldSortOptions', ], 'max' => 100, ], 'S3Bucket' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'S3BucketConfiguration' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'BucketPrefix', 'BucketRegion', ], 'members' => [ 'BucketName' => [ 'shape' => 'NonEmptyString', ], 'BucketPrefix' => [ 'shape' => 'NonEmptyString', ], 'BucketRegion' => [ 'shape' => 'NonEmptyString', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'S3Parameters' => [ 'type' => 'structure', 'required' => [ 'ManifestFileLocation', ], 'members' => [ 'ManifestFileLocation' => [ 'shape' => 'ManifestFileLocation', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Source' => [ 'type' => 'structure', 'required' => [ 'DataSourceArn', 'InputColumns', ], 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'UploadSettings' => [ 'shape' => 'UploadSettings', ], 'InputColumns' => [ 'shape' => 'InputColumnList', ], ], ], 'S3Uri' => [ 'type' => 'string', 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SameSheetTargetVisualConfiguration' => [ 'type' => 'structure', 'members' => [ 'TargetVisuals' => [ 'shape' => 'TargetVisualList', ], 'TargetVisualOptions' => [ 'shape' => 'TargetVisualOptions', ], ], ], 'SankeyDiagramAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Source' => [ 'shape' => 'DimensionFieldList', ], 'Destination' => [ 'shape' => 'DimensionFieldList', ], 'Weight' => [ 'shape' => 'MeasureFieldList', ], ], ], 'SankeyDiagramChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'SankeyDiagramFieldWells', ], 'SortConfiguration' => [ 'shape' => 'SankeyDiagramSortConfiguration', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'SankeyDiagramFieldWells' => [ 'type' => 'structure', 'members' => [ 'SankeyDiagramAggregatedFieldWells' => [ 'shape' => 'SankeyDiagramAggregatedFieldWells', ], ], ], 'SankeyDiagramSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'WeightSort' => [ 'shape' => 'FieldSortOptionsList', ], 'SourceItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'DestinationItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'SankeyDiagramVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'SankeyDiagramChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'XAxis' => [ 'shape' => 'MeasureFieldList', ], 'YAxis' => [ 'shape' => 'MeasureFieldList', ], 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Size' => [ 'shape' => 'MeasureFieldList', ], 'Label' => [ 'shape' => 'DimensionFieldList', ], ], ], 'ScatterPlotConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'ScatterPlotFieldWells', ], 'SortConfiguration' => [ 'shape' => 'ScatterPlotSortConfiguration', ], 'XAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'XAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'YAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'YAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'ScatterPlotFieldWells' => [ 'type' => 'structure', 'members' => [ 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'shape' => 'ScatterPlotCategoricallyAggregatedFieldWells', ], 'ScatterPlotUnaggregatedFieldWells' => [ 'shape' => 'ScatterPlotUnaggregatedFieldWells', ], ], ], 'ScatterPlotSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'ScatterPlotLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'ScatterPlotUnaggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'XAxis' => [ 'shape' => 'DimensionFieldList', ], 'YAxis' => [ 'shape' => 'DimensionFieldList', ], 'Size' => [ 'shape' => 'MeasureFieldList', ], 'Category' => [ 'shape' => 'DimensionFieldList', ], 'Label' => [ 'shape' => 'DimensionFieldList', ], ], ], 'ScatterPlotVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'ScatterPlotConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'ScheduleRefreshOnEntity' => [ 'type' => 'structure', 'members' => [ 'DayOfWeek' => [ 'shape' => 'DayOfWeek', ], 'DayOfMonth' => [ 'shape' => 'DayOfMonth', ], ], ], 'ScrollBarOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'VisibleRange' => [ 'shape' => 'VisibleRangeOptions', ], ], ], 'SearchAnalysesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'AnalysisSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchAnalysesResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisSummaryList' => [ 'shape' => 'AnalysisSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDashboardsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DashboardSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDashboardsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardSummaryList' => [ 'shape' => 'DashboardSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDataSetsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DataSetSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDataSetsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetSummaries' => [ 'shape' => 'DataSetSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'DataSourceSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceSummaries' => [ 'shape' => 'DataSourceSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchFoldersRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Filters' => [ 'shape' => 'FolderSearchFilterList', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'SearchFoldersResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'FolderSummaryList' => [ 'shape' => 'FolderSummaryList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'SearchGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Namespace', 'Filters', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'NextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'next-token', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'max-results', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Filters' => [ 'shape' => 'GroupSearchFilterList', ], ], ], 'SearchGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'GroupList' => [ 'shape' => 'GroupList', ], 'NextToken' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'Seasonality' => [ 'type' => 'integer', 'max' => 180, 'min' => 1, ], 'SecondaryValueOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+', ], 'SectionAfterPageBreak' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SectionPageBreakStatus', ], ], ], 'SectionBasedLayoutCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'PaperCanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutPaperCanvasSizeOptions', ], ], ], 'SectionBasedLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'HeaderSections', 'BodySections', 'FooterSections', 'CanvasSizeOptions', ], 'members' => [ 'HeaderSections' => [ 'shape' => 'HeaderFooterSectionConfigurationList', ], 'BodySections' => [ 'shape' => 'BodySectionConfigurationList', ], 'FooterSections' => [ 'shape' => 'HeaderFooterSectionConfigurationList', ], 'CanvasSizeOptions' => [ 'shape' => 'SectionBasedLayoutCanvasSizeOptions', ], ], ], 'SectionBasedLayoutPaperCanvasSizeOptions' => [ 'type' => 'structure', 'members' => [ 'PaperSize' => [ 'shape' => 'PaperSize', ], 'PaperOrientation' => [ 'shape' => 'PaperOrientation', ], 'PaperMargin' => [ 'shape' => 'Spacing', ], ], ], 'SectionLayoutConfiguration' => [ 'type' => 'structure', 'required' => [ 'FreeFormLayout', ], 'members' => [ 'FreeFormLayout' => [ 'shape' => 'FreeFormSectionLayoutConfiguration', ], ], ], 'SectionPageBreakConfiguration' => [ 'type' => 'structure', 'members' => [ 'After' => [ 'shape' => 'SectionAfterPageBreak', ], ], ], 'SectionPageBreakStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SectionStyle' => [ 'type' => 'structure', 'members' => [ 'Height' => [ 'shape' => 'PixelLength', ], 'Padding' => [ 'shape' => 'Spacing', ], ], ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^sg-[0-9a-z]*$', ], 'SecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 16, 'min' => 1, ], 'SelectAllValueOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_VALUES', ], ], 'SelectedFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 20, 'min' => 1, ], 'SelectedFieldOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_FIELDS', ], ], 'SelectedSheetsFilterScopeConfiguration' => [ 'type' => 'structure', 'members' => [ 'SheetVisualScopingConfigurations' => [ 'shape' => 'SheetVisualScopingConfigurations', ], ], ], 'SelectedTooltipType' => [ 'type' => 'string', 'enum' => [ 'BASIC', 'DETAILED', ], ], 'SemanticEntityType' => [ 'type' => 'structure', 'members' => [ 'TypeName' => [ 'shape' => 'LimitedString', ], 'SubTypeName' => [ 'shape' => 'LimitedString', ], 'TypeParameters' => [ 'shape' => 'TypeParameters', ], ], ], 'SemanticType' => [ 'type' => 'structure', 'members' => [ 'TypeName' => [ 'shape' => 'LimitedString', ], 'SubTypeName' => [ 'shape' => 'LimitedString', ], 'TypeParameters' => [ 'shape' => 'TypeParameters', ], 'TruthyCellValue' => [ 'shape' => 'SensitiveString', ], 'TruthyCellValueSynonyms' => [ 'shape' => 'SensitiveStringList', ], 'FalseyCellValue' => [ 'shape' => 'SensitiveString', ], 'FalseyCellValueSynonyms' => [ 'shape' => 'SensitiveStringList', ], ], ], 'SensitiveDouble' => [ 'type' => 'double', 'sensitive' => true, ], 'SensitiveDoubleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveDouble', ], ], 'SensitiveDoubleObject' => [ 'type' => 'double', 'sensitive' => true, ], 'SensitiveLong' => [ 'type' => 'long', 'sensitive' => true, ], 'SensitiveLongList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveLong', ], ], 'SensitiveLongObject' => [ 'type' => 'long', 'sensitive' => true, ], 'SensitiveS3Uri' => [ 'type' => 'string', 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveString', ], ], 'SensitiveStringObject' => [ 'type' => 'string', 'sensitive' => true, ], 'SensitiveTimestamp' => [ 'type' => 'timestamp', 'sensitive' => true, ], 'SensitiveTimestampList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveTimestamp', ], ], 'SeriesItem' => [ 'type' => 'structure', 'members' => [ 'FieldSeriesItem' => [ 'shape' => 'FieldSeriesItem', ], 'DataFieldSeriesItem' => [ 'shape' => 'DataFieldSeriesItem', ], ], ], 'SeriesItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SeriesItem', ], 'max' => 2000, ], 'ServiceNowParameters' => [ 'type' => 'structure', 'required' => [ 'SiteBaseUrl', ], 'members' => [ 'SiteBaseUrl' => [ 'shape' => 'SiteBaseUrl', ], ], ], 'ServiceType' => [ 'type' => 'string', 'enum' => [ 'REDSHIFT', ], ], 'SessionLifetimeInMinutes' => [ 'type' => 'long', 'max' => 600, 'min' => 15, ], 'SessionLifetimeInMinutesInvalidException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'SessionTag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'SessionTagKey', ], 'Value' => [ 'shape' => 'SessionTagValue', ], ], ], 'SessionTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SessionTagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTagKey', ], 'max' => 50, 'min' => 1, ], 'SessionTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionTag', ], 'max' => 50, 'min' => 1, ], 'SessionTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'sensitive' => true, ], 'SetParameterValueConfiguration' => [ 'type' => 'structure', 'required' => [ 'DestinationParameterName', 'Value', ], 'members' => [ 'DestinationParameterName' => [ 'shape' => 'ParameterName', ], 'Value' => [ 'shape' => 'DestinationParameterValueConfiguration', ], ], ], 'SetParameterValueConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SetParameterValueConfiguration', ], 'max' => 200, 'min' => 1, ], 'ShapeConditionalFormat' => [ 'type' => 'structure', 'required' => [ 'BackgroundColor', ], 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'SharedViewConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'SharingModel' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'NAMESPACE', ], ], 'Sheet' => [ 'type' => 'structure', 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'SheetName', ], ], ], 'SheetContentType' => [ 'type' => 'string', 'enum' => [ 'PAGINATED', 'INTERACTIVE', ], ], 'SheetControlDateTimePickerType' => [ 'type' => 'string', 'enum' => [ 'SINGLE_VALUED', 'DATE_RANGE', ], ], 'SheetControlInfoIconLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'InfoIconText' => [ 'shape' => 'SheetControlInfoIconText', ], ], ], 'SheetControlInfoIconText' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SheetControlLayout' => [ 'type' => 'structure', 'required' => [ 'Configuration', ], 'members' => [ 'Configuration' => [ 'shape' => 'SheetControlLayoutConfiguration', ], ], ], 'SheetControlLayoutConfiguration' => [ 'type' => 'structure', 'members' => [ 'GridLayout' => [ 'shape' => 'GridLayoutConfiguration', ], ], ], 'SheetControlLayoutList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetControlLayout', ], 'max' => 1, 'min' => 0, ], 'SheetControlListType' => [ 'type' => 'string', 'enum' => [ 'MULTI_SELECT', 'SINGLE_SELECT', ], ], 'SheetControlSliderType' => [ 'type' => 'string', 'enum' => [ 'SINGLE_POINT', 'RANGE', ], ], 'SheetControlTitle' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'SheetControlsOption' => [ 'type' => 'structure', 'members' => [ 'VisibilityState' => [ 'shape' => 'DashboardUIState', ], ], ], 'SheetDefinition' => [ 'type' => 'structure', 'required' => [ 'SheetId', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'SheetTitle', ], 'Description' => [ 'shape' => 'SheetDescription', ], 'Name' => [ 'shape' => 'SheetName', ], 'ParameterControls' => [ 'shape' => 'ParameterControlList', ], 'FilterControls' => [ 'shape' => 'FilterControlList', ], 'Visuals' => [ 'shape' => 'VisualList', ], 'TextBoxes' => [ 'shape' => 'SheetTextBoxList', ], 'Layouts' => [ 'shape' => 'LayoutList', ], 'SheetControlLayouts' => [ 'shape' => 'SheetControlLayoutList', ], 'ContentType' => [ 'shape' => 'SheetContentType', ], ], ], 'SheetDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetDefinition', ], 'max' => 20, ], 'SheetDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SheetElementConfigurationOverrides' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'SheetElementRenderingRule' => [ 'type' => 'structure', 'required' => [ 'Expression', 'ConfigurationOverrides', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'ConfigurationOverrides' => [ 'shape' => 'SheetElementConfigurationOverrides', ], ], ], 'SheetElementRenderingRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetElementRenderingRule', ], 'max' => 10000, ], 'SheetLayoutElementMaximizationOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'SheetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Sheet', ], 'max' => 20, ], 'SheetName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'SheetStyle' => [ 'type' => 'structure', 'members' => [ 'Tile' => [ 'shape' => 'TileStyle', ], 'TileLayout' => [ 'shape' => 'TileLayoutStyle', ], ], ], 'SheetTextBox' => [ 'type' => 'structure', 'required' => [ 'SheetTextBoxId', ], 'members' => [ 'SheetTextBoxId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Content' => [ 'shape' => 'SheetTextBoxContent', ], ], ], 'SheetTextBoxContent' => [ 'type' => 'string', 'max' => 150000, ], 'SheetTextBoxList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetTextBox', ], 'max' => 100, ], 'SheetTitle' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SheetVisualScopingConfiguration' => [ 'type' => 'structure', 'required' => [ 'SheetId', 'Scope', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Scope' => [ 'shape' => 'FilterVisualScope', ], 'VisualIds' => [ 'shape' => 'FilteredVisualsList', ], ], ], 'SheetVisualScopingConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'SheetVisualScopingConfiguration', ], 'max' => 50, 'min' => 1, ], 'ShortFormatText' => [ 'type' => 'structure', 'members' => [ 'PlainText' => [ 'shape' => 'ShortPlainText', ], 'RichText' => [ 'shape' => 'ShortRichText', ], ], ], 'ShortPlainText' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ShortRestrictiveResourceId' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ShortRichText' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SignupResponse' => [ 'type' => 'structure', 'members' => [ 'IAMUser' => [ 'shape' => 'Boolean', ], 'userLoginName' => [ 'shape' => 'String', ], 'accountName' => [ 'shape' => 'String', ], 'directoryType' => [ 'shape' => 'String', ], ], ], 'SimpleAttributeAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'UNIQUE_VALUE', ], ], 'SimpleClusterMarker' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], ], ], 'SimpleNumericalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'SUM', 'AVERAGE', 'MIN', 'MAX', 'COUNT', 'DISTINCT_COUNT', 'VAR', 'VARP', 'STDEV', 'STDEVP', 'MEDIAN', ], ], 'SimpleTotalAggregationFunction' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'SUM', 'AVERAGE', 'MIN', 'MAX', 'NONE', ], ], 'SingleAxisOptions' => [ 'type' => 'structure', 'members' => [ 'YAxisOptions' => [ 'shape' => 'YAxisOptions', ], ], ], 'SingleYAxisOption' => [ 'type' => 'string', 'enum' => [ 'PRIMARY_Y_AXIS', ], ], 'SiteBaseUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SliderControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'Slot' => [ 'type' => 'structure', 'members' => [ 'SlotId' => [ 'shape' => 'LimitedString', ], 'VisualId' => [ 'shape' => 'LimitedString', ], ], ], 'Slots' => [ 'type' => 'list', 'member' => [ 'shape' => 'Slot', ], ], 'SmallMultiplesAxisPlacement' => [ 'type' => 'string', 'enum' => [ 'OUTSIDE', 'INSIDE', ], ], 'SmallMultiplesAxisProperties' => [ 'type' => 'structure', 'members' => [ 'Scale' => [ 'shape' => 'SmallMultiplesAxisScale', ], 'Placement' => [ 'shape' => 'SmallMultiplesAxisPlacement', ], ], ], 'SmallMultiplesAxisScale' => [ 'type' => 'string', 'enum' => [ 'SHARED', 'INDEPENDENT', ], ], 'SmallMultiplesDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'SmallMultiplesOptions' => [ 'type' => 'structure', 'members' => [ 'MaxVisibleRows' => [ 'shape' => 'VisiblePanelRows', ], 'MaxVisibleColumns' => [ 'shape' => 'VisiblePanelColumns', ], 'PanelConfiguration' => [ 'shape' => 'PanelConfiguration', ], 'XAxis' => [ 'shape' => 'SmallMultiplesAxisProperties', ], 'YAxis' => [ 'shape' => 'SmallMultiplesAxisProperties', ], ], ], 'SnapshotAnonymousUser' => [ 'type' => 'structure', 'members' => [ 'RowLevelPermissionTags' => [ 'shape' => 'SessionTagList', ], ], ], 'SnapshotAnonymousUserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotAnonymousUser', ], 'max' => 1, 'min' => 1, ], 'SnapshotAnonymousUserRedacted' => [ 'type' => 'structure', 'members' => [ 'RowLevelPermissionTagKeys' => [ 'shape' => 'SessionTagKeyList', ], ], ], 'SnapshotAnonymousUserRedactedList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotAnonymousUserRedacted', ], 'max' => 1, 'min' => 1, ], 'SnapshotConfiguration' => [ 'type' => 'structure', 'required' => [ 'FileGroups', ], 'members' => [ 'FileGroups' => [ 'shape' => 'SnapshotFileGroupList', ], 'DestinationConfiguration' => [ 'shape' => 'SnapshotDestinationConfiguration', ], 'Parameters' => [ 'shape' => 'Parameters', ], ], ], 'SnapshotDestinationConfiguration' => [ 'type' => 'structure', 'members' => [ 'S3Destinations' => [ 'shape' => 'SnapshotS3DestinationConfigurationList', ], ], ], 'SnapshotFile' => [ 'type' => 'structure', 'required' => [ 'SheetSelections', 'FormatType', ], 'members' => [ 'SheetSelections' => [ 'shape' => 'SnapshotFileSheetSelectionList', ], 'FormatType' => [ 'shape' => 'SnapshotFileFormatType', ], ], ], 'SnapshotFileFormatType' => [ 'type' => 'string', 'enum' => [ 'CSV', 'PDF', 'EXCEL', ], ], 'SnapshotFileGroup' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'SnapshotFileList', ], ], ], 'SnapshotFileGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFileGroup', ], 'max' => 7, 'min' => 1, ], 'SnapshotFileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFile', ], 'max' => 1, 'min' => 1, ], 'SnapshotFileSheetSelection' => [ 'type' => 'structure', 'required' => [ 'SheetId', 'SelectionScope', ], 'members' => [ 'SheetId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'SelectionScope' => [ 'shape' => 'SnapshotFileSheetSelectionScope', ], 'VisualIds' => [ 'shape' => 'SnapshotFileSheetSelectionVisualIdList', ], ], ], 'SnapshotFileSheetSelectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotFileSheetSelection', ], 'max' => 5, 'min' => 1, ], 'SnapshotFileSheetSelectionScope' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', 'SELECTED_VISUALS', ], ], 'SnapshotFileSheetSelectionVisualIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 5, 'min' => 1, ], 'SnapshotJobErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], ], ], 'SnapshotJobResult' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'AnonymousUserSnapshotJobResultList', ], ], ], 'SnapshotJobResultErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], ], ], 'SnapshotJobResultErrorInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobResultErrorInfo', ], ], 'SnapshotJobResultFileGroup' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'SnapshotFileList', ], 'S3Results' => [ 'shape' => 'SnapshotJobS3ResultList', ], ], ], 'SnapshotJobResultFileGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobResultFileGroup', ], ], 'SnapshotJobS3Result' => [ 'type' => 'structure', 'members' => [ 'S3DestinationConfiguration' => [ 'shape' => 'SnapshotS3DestinationConfiguration', ], 'S3Uri' => [ 'shape' => 'SensitiveS3Uri', ], 'ErrorInfo' => [ 'shape' => 'SnapshotJobResultErrorInfoList', ], ], ], 'SnapshotJobS3ResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotJobS3Result', ], ], 'SnapshotJobStatus' => [ 'type' => 'string', 'enum' => [ 'QUEUED', 'RUNNING', 'COMPLETED', 'FAILED', ], ], 'SnapshotS3DestinationConfiguration' => [ 'type' => 'structure', 'required' => [ 'BucketConfiguration', ], 'members' => [ 'BucketConfiguration' => [ 'shape' => 'S3BucketConfiguration', ], ], ], 'SnapshotS3DestinationConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotS3DestinationConfiguration', ], 'max' => 1, 'min' => 1, ], 'SnapshotUserConfiguration' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'SnapshotAnonymousUserList', ], ], ], 'SnapshotUserConfigurationRedacted' => [ 'type' => 'structure', 'members' => [ 'AnonymousUsers' => [ 'shape' => 'SnapshotAnonymousUserRedactedList', ], ], ], 'SnowflakeParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Database', 'Warehouse', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Database' => [ 'shape' => 'Database', ], 'Warehouse' => [ 'shape' => 'Warehouse', ], ], ], 'SortDirection' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'Spacing' => [ 'type' => 'structure', 'members' => [ 'Top' => [ 'shape' => 'Length', ], 'Bottom' => [ 'shape' => 'Length', ], 'Left' => [ 'shape' => 'Length', ], 'Right' => [ 'shape' => 'Length', ], ], ], 'SparkParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], ], ], 'SpecialValue' => [ 'type' => 'string', 'enum' => [ 'EMPTY', 'NULL', 'OTHER', ], ], 'SqlEndpointPath' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'SqlQuery' => [ 'type' => 'string', 'max' => 168000, 'min' => 1, ], 'SqlServerParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'SslProperties' => [ 'type' => 'structure', 'members' => [ 'DisableSsl' => [ 'shape' => 'Boolean', ], ], ], 'StarburstParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'ProductType' => [ 'shape' => 'StarburstProductType', ], ], ], 'StarburstProductType' => [ 'type' => 'string', 'enum' => [ 'GALAXY', 'ENTERPRISE', ], ], 'StartAssetBundleExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleExportJobId', 'ResourceArns', 'ExportFormat', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ResourceArns' => [ 'shape' => 'AssetBundleResourceArns', ], 'IncludeAllDependencies' => [ 'shape' => 'Boolean', ], 'ExportFormat' => [ 'shape' => 'AssetBundleExportFormat', ], 'CloudFormationOverridePropertyConfiguration' => [ 'shape' => 'AssetBundleCloudFormationOverridePropertyConfiguration', ], 'IncludePermissions' => [ 'shape' => 'Boolean', ], 'IncludeTags' => [ 'shape' => 'Boolean', ], 'ValidationStrategy' => [ 'shape' => 'AssetBundleExportJobValidationStrategy', ], ], ], 'StartAssetBundleExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AssetBundleExportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StartAssetBundleImportJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssetBundleImportJobId', 'AssetBundleImportSource', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'AssetBundleImportSource' => [ 'shape' => 'AssetBundleImportSource', ], 'OverrideParameters' => [ 'shape' => 'AssetBundleImportJobOverrideParameters', ], 'FailureAction' => [ 'shape' => 'AssetBundleImportFailureAction', ], 'OverridePermissions' => [ 'shape' => 'AssetBundleImportJobOverridePermissions', ], 'OverrideTags' => [ 'shape' => 'AssetBundleImportJobOverrideTags', ], 'OverrideValidationStrategy' => [ 'shape' => 'AssetBundleImportJobOverrideValidationStrategy', ], ], ], 'StartAssetBundleImportJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AssetBundleImportJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StartDashboardSnapshotJobRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'SnapshotJobId', 'UserConfiguration', 'SnapshotConfiguration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UserConfiguration' => [ 'shape' => 'SnapshotUserConfiguration', ], 'SnapshotConfiguration' => [ 'shape' => 'SnapshotConfiguration', ], ], ], 'StartDashboardSnapshotJobResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'SnapshotJobId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'StatePersistenceConfigurations' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'StatusCode' => [ 'type' => 'integer', ], 'String' => [ 'type' => 'string', ], 'StringDatasetParameter' => [ 'type' => 'structure', 'required' => [ 'Id', 'Name', 'ValueType', ], 'members' => [ 'Id' => [ 'shape' => 'DatasetParameterId', ], 'Name' => [ 'shape' => 'DatasetParameterName', ], 'ValueType' => [ 'shape' => 'DatasetParameterValueType', ], 'DefaultValues' => [ 'shape' => 'StringDatasetParameterDefaultValues', ], ], ], 'StringDatasetParameterDefaultValue' => [ 'type' => 'string', 'max' => 512, 'min' => 0, ], 'StringDatasetParameterDefaultValues' => [ 'type' => 'structure', 'members' => [ 'StaticValues' => [ 'shape' => 'StringDatasetParameterValueList', ], ], ], 'StringDatasetParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringDatasetParameterDefaultValue', ], 'max' => 32, 'min' => 1, ], 'StringDefaultValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SensitiveStringObject', ], 'max' => 50000, ], 'StringDefaultValues' => [ 'type' => 'structure', 'members' => [ 'DynamicValue' => [ 'shape' => 'DynamicDefaultValue', ], 'StaticValues' => [ 'shape' => 'StringDefaultValueList', ], ], ], 'StringFormatConfiguration' => [ 'type' => 'structure', 'members' => [ 'NullValueFormatConfiguration' => [ 'shape' => 'NullValueFormatConfiguration', ], 'NumericFormatConfiguration' => [ 'shape' => 'NumericFormatConfiguration', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'NonEmptyString', ], 'Values' => [ 'shape' => 'SensitiveStringList', ], ], ], 'StringParameterDeclaration' => [ 'type' => 'structure', 'required' => [ 'ParameterValueType', 'Name', ], 'members' => [ 'ParameterValueType' => [ 'shape' => 'ParameterValueType', ], 'Name' => [ 'shape' => 'ParameterName', ], 'DefaultValues' => [ 'shape' => 'StringDefaultValues', ], 'ValueWhenUnset' => [ 'shape' => 'StringValueWhenUnsetConfiguration', ], 'MappedDataSetParameters' => [ 'shape' => 'MappedDataSetParameters', ], ], ], 'StringParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameter', ], 'max' => 100, ], 'StringValueWhenUnsetConfiguration' => [ 'type' => 'structure', 'members' => [ 'ValueWhenUnsetOption' => [ 'shape' => 'ValueWhenUnsetOption', ], 'CustomValue' => [ 'shape' => 'SensitiveString', ], ], ], 'StyledCellType' => [ 'type' => 'string', 'enum' => [ 'TOTAL', 'METRIC_HEADER', 'VALUE', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^subnet-[0-9a-z]*$', ], 'SubnetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 15, 'min' => 2, ], 'SubtotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'CustomLabel' => [ 'shape' => 'String', ], 'FieldLevel' => [ 'shape' => 'PivotTableSubtotalLevel', ], 'FieldLevelOptions' => [ 'shape' => 'PivotTableFieldSubtotalOptionsList', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'ValueCellStyle' => [ 'shape' => 'TableCellStyle', ], 'MetricHeaderCellStyle' => [ 'shape' => 'TableCellStyle', ], 'StyleTargets' => [ 'shape' => 'TableStyleTargetList', ], ], ], 'SucceededTopicReviewedAnswer' => [ 'type' => 'structure', 'members' => [ 'AnswerId' => [ 'shape' => 'AnswerId', ], ], ], 'SucceededTopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'SucceededTopicReviewedAnswer', ], ], 'SuccessfulKeyRegistrationEntries' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessfulKeyRegistrationEntry', ], ], 'SuccessfulKeyRegistrationEntry' => [ 'type' => 'structure', 'required' => [ 'KeyArn', 'StatusCode', ], 'members' => [ 'KeyArn' => [ 'shape' => 'String', ], 'StatusCode' => [ 'shape' => 'StatusCode', ], ], ], 'Suffix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'sensitive' => true, ], 'Synonyms' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitedString', ], ], 'TableAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], ], ], 'TableBorderOptions' => [ 'type' => 'structure', 'members' => [ 'Color' => [ 'shape' => 'HexColor', ], 'Thickness' => [ 'shape' => 'TableBorderThickness', ], 'Style' => [ 'shape' => 'TableBorderStyle', ], ], ], 'TableBorderStyle' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SOLID', ], ], 'TableBorderThickness' => [ 'type' => 'integer', 'max' => 4, 'min' => 1, ], 'TableCellConditionalFormatting' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TextFormat' => [ 'shape' => 'TextConditionalFormat', ], ], ], 'TableCellImageScalingConfiguration' => [ 'type' => 'string', 'enum' => [ 'FIT_TO_CELL_HEIGHT', 'FIT_TO_CELL_WIDTH', 'DO_NOT_SCALE', ], ], 'TableCellImageSizingConfiguration' => [ 'type' => 'structure', 'members' => [ 'TableCellImageScalingConfiguration' => [ 'shape' => 'TableCellImageScalingConfiguration', ], ], ], 'TableCellStyle' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], 'TextWrap' => [ 'shape' => 'TextWrap', ], 'HorizontalTextAlignment' => [ 'shape' => 'HorizontalTextAlignment', ], 'VerticalTextAlignment' => [ 'shape' => 'VerticalTextAlignment', ], 'BackgroundColor' => [ 'shape' => 'HexColor', ], 'Height' => [ 'shape' => 'TableFieldHeight', ], 'Border' => [ 'shape' => 'GlobalTableBorderOptions', ], ], ], 'TableConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'ConditionalFormattingOptions' => [ 'shape' => 'TableConditionalFormattingOptionList', ], ], ], 'TableConditionalFormattingOption' => [ 'type' => 'structure', 'members' => [ 'Cell' => [ 'shape' => 'TableCellConditionalFormatting', ], 'Row' => [ 'shape' => 'TableRowConditionalFormatting', ], ], ], 'TableConditionalFormattingOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableConditionalFormattingOption', ], 'max' => 500, ], 'TableConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'TableFieldWells', ], 'SortConfiguration' => [ 'shape' => 'TableSortConfiguration', ], 'TableOptions' => [ 'shape' => 'TableOptions', ], 'TotalOptions' => [ 'shape' => 'TotalOptions', ], 'FieldOptions' => [ 'shape' => 'TableFieldOptions', ], 'PaginatedReportOptions' => [ 'shape' => 'TablePaginatedReportOptions', ], 'TableInlineVisualizations' => [ 'shape' => 'TableInlineVisualizationList', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'TableFieldCustomIconContent' => [ 'type' => 'structure', 'members' => [ 'Icon' => [ 'shape' => 'TableFieldIconSetType', ], ], ], 'TableFieldCustomTextContent' => [ 'type' => 'structure', 'required' => [ 'FontConfiguration', ], 'members' => [ 'Value' => [ 'shape' => 'String', ], 'FontConfiguration' => [ 'shape' => 'FontConfiguration', ], ], ], 'TableFieldHeight' => [ 'type' => 'integer', 'max' => 500, 'min' => 8, ], 'TableFieldIconSetType' => [ 'type' => 'string', 'enum' => [ 'LINK', ], ], 'TableFieldImageConfiguration' => [ 'type' => 'structure', 'members' => [ 'SizingOptions' => [ 'shape' => 'TableCellImageSizingConfiguration', ], ], ], 'TableFieldLinkConfiguration' => [ 'type' => 'structure', 'required' => [ 'Target', 'Content', ], 'members' => [ 'Target' => [ 'shape' => 'URLTargetConfiguration', ], 'Content' => [ 'shape' => 'TableFieldLinkContentConfiguration', ], ], ], 'TableFieldLinkContentConfiguration' => [ 'type' => 'structure', 'members' => [ 'CustomTextContent' => [ 'shape' => 'TableFieldCustomTextContent', ], 'CustomIconContent' => [ 'shape' => 'TableFieldCustomIconContent', ], ], ], 'TableFieldOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Width' => [ 'shape' => 'PixelLength', ], 'CustomLabel' => [ 'shape' => 'CustomLabel', ], 'Visibility' => [ 'shape' => 'Visibility', ], 'URLStyling' => [ 'shape' => 'TableFieldURLConfiguration', ], ], ], 'TableFieldOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableFieldOption', ], 'max' => 100, ], 'TableFieldOptions' => [ 'type' => 'structure', 'members' => [ 'SelectedFieldOptions' => [ 'shape' => 'TableFieldOptionList', ], 'Order' => [ 'shape' => 'FieldOrderList', ], 'PinnedFieldOptions' => [ 'shape' => 'TablePinnedFieldOptions', ], ], ], 'TableFieldOrderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldId', ], 'max' => 201, ], 'TableFieldURLConfiguration' => [ 'type' => 'structure', 'members' => [ 'LinkConfiguration' => [ 'shape' => 'TableFieldLinkConfiguration', ], 'ImageConfiguration' => [ 'shape' => 'TableFieldImageConfiguration', ], ], ], 'TableFieldWells' => [ 'type' => 'structure', 'members' => [ 'TableAggregatedFieldWells' => [ 'shape' => 'TableAggregatedFieldWells', ], 'TableUnaggregatedFieldWells' => [ 'shape' => 'TableUnaggregatedFieldWells', ], ], ], 'TableInlineVisualization' => [ 'type' => 'structure', 'members' => [ 'DataBars' => [ 'shape' => 'DataBarsOptions', ], ], ], 'TableInlineVisualizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableInlineVisualization', ], 'max' => 200, ], 'TableOptions' => [ 'type' => 'structure', 'members' => [ 'Orientation' => [ 'shape' => 'TableOrientation', ], 'HeaderStyle' => [ 'shape' => 'TableCellStyle', ], 'CellStyle' => [ 'shape' => 'TableCellStyle', ], 'RowAlternateColorOptions' => [ 'shape' => 'RowAlternateColorOptions', ], ], ], 'TableOrientation' => [ 'type' => 'string', 'enum' => [ 'VERTICAL', 'HORIZONTAL', ], ], 'TablePaginatedReportOptions' => [ 'type' => 'structure', 'members' => [ 'VerticalOverflowVisibility' => [ 'shape' => 'Visibility', ], 'OverflowColumnHeaderVisibility' => [ 'shape' => 'Visibility', ], ], ], 'TablePinnedFieldOptions' => [ 'type' => 'structure', 'members' => [ 'PinnedLeftFields' => [ 'shape' => 'TableFieldOrderList', ], ], ], 'TableRowConditionalFormatting' => [ 'type' => 'structure', 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], ], ], 'TableSideBorderOptions' => [ 'type' => 'structure', 'members' => [ 'InnerVertical' => [ 'shape' => 'TableBorderOptions', ], 'InnerHorizontal' => [ 'shape' => 'TableBorderOptions', ], 'Left' => [ 'shape' => 'TableBorderOptions', ], 'Right' => [ 'shape' => 'TableBorderOptions', ], 'Top' => [ 'shape' => 'TableBorderOptions', ], 'Bottom' => [ 'shape' => 'TableBorderOptions', ], ], ], 'TableSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'RowSort' => [ 'shape' => 'RowSortList', ], 'PaginationConfiguration' => [ 'shape' => 'PaginationConfiguration', ], ], ], 'TableStyleTarget' => [ 'type' => 'structure', 'required' => [ 'CellType', ], 'members' => [ 'CellType' => [ 'shape' => 'StyledCellType', ], ], ], 'TableStyleTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TableStyleTarget', ], 'max' => 3, ], 'TableTotalsPlacement' => [ 'type' => 'string', 'enum' => [ 'START', 'END', 'AUTO', ], ], 'TableTotalsScrollStatus' => [ 'type' => 'string', 'enum' => [ 'PINNED', 'SCROLLED', ], ], 'TableUnaggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Values' => [ 'shape' => 'UnaggregatedFieldList', ], ], ], 'TableVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'TableConfiguration', ], 'ConditionalFormatting' => [ 'shape' => 'TableConditionalFormatting', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'Tags', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'Tags' => [ 'shape' => 'ColumnTagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetVisualList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'max' => 50, 'min' => 1, ], 'TargetVisualOptions' => [ 'type' => 'string', 'enum' => [ 'ALL_VISUALS', ], ], 'Template' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Version' => [ 'shape' => 'TemplateVersion', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TemplateAlias' => [ 'type' => 'structure', 'members' => [ 'AliasName' => [ 'shape' => 'AliasName', ], 'Arn' => [ 'shape' => 'Arn', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'TemplateAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateAlias', ], 'max' => 100, ], 'TemplateError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'TemplateErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'ViolatedEntities' => [ 'shape' => 'EntityList', ], ], ], 'TemplateErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateError', ], 'min' => 1, ], 'TemplateErrorType' => [ 'type' => 'string', 'enum' => [ 'SOURCE_NOT_FOUND', 'DATA_SET_NOT_FOUND', 'INTERNAL_FAILURE', 'ACCESS_DENIED', ], ], 'TemplateName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TemplateSourceAnalysis' => [ 'type' => 'structure', 'required' => [ 'Arn', 'DataSetReferences', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetReferences' => [ 'shape' => 'DataSetReferenceList', ], ], ], 'TemplateSourceEntity' => [ 'type' => 'structure', 'members' => [ 'SourceAnalysis' => [ 'shape' => 'TemplateSourceAnalysis', ], 'SourceTemplate' => [ 'shape' => 'TemplateSourceTemplate', ], ], ], 'TemplateSourceTemplate' => [ 'type' => 'structure', 'required' => [ 'Arn', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], ], ], 'TemplateSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'TemplateName', ], 'LatestVersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TemplateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateSummary', ], 'max' => 100, ], 'TemplateVersion' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Errors' => [ 'shape' => 'TemplateErrorList', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'DataSetConfigurations' => [ 'shape' => 'DataSetConfigurationList', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'SourceEntityArn' => [ 'shape' => 'Arn', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Sheets' => [ 'shape' => 'SheetList', ], ], ], 'TemplateVersionDefinition' => [ 'type' => 'structure', 'required' => [ 'DataSetConfigurations', ], 'members' => [ 'DataSetConfigurations' => [ 'shape' => 'DataSetConfigurationList', ], 'Sheets' => [ 'shape' => 'SheetDefinitionList', ], 'CalculatedFields' => [ 'shape' => 'CalculatedFields', ], 'ParameterDeclarations' => [ 'shape' => 'ParameterDeclarationList', ], 'FilterGroups' => [ 'shape' => 'FilterGroupList', ], 'ColumnConfigurations' => [ 'shape' => 'ColumnConfigurationList', ], 'AnalysisDefaults' => [ 'shape' => 'AnalysisDefaults', ], 'Options' => [ 'shape' => 'AssetOptions', ], 'QueryExecutionOptions' => [ 'shape' => 'QueryExecutionOptions', ], ], ], 'TemplateVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ResourceStatus', ], 'Description' => [ 'shape' => 'VersionDescription', ], ], ], 'TemplateVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TemplateVersionSummary', ], 'max' => 100, ], 'TeradataParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Database', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'TextAreaControlDelimiter' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TextAreaControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'PlaceholderOptions' => [ 'shape' => 'TextControlPlaceholderOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'TextConditionalFormat' => [ 'type' => 'structure', 'members' => [ 'BackgroundColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'TextColor' => [ 'shape' => 'ConditionalFormattingColor', ], 'Icon' => [ 'shape' => 'ConditionalFormattingIcon', ], ], ], 'TextControlPlaceholderOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'TextFieldControlDisplayOptions' => [ 'type' => 'structure', 'members' => [ 'TitleOptions' => [ 'shape' => 'LabelOptions', ], 'PlaceholderOptions' => [ 'shape' => 'TextControlPlaceholderOptions', ], 'InfoIconLabelOptions' => [ 'shape' => 'SheetControlInfoIconLabelOptions', ], ], ], 'TextQualifier' => [ 'type' => 'string', 'enum' => [ 'DOUBLE_QUOTE', 'SINGLE_QUOTE', ], ], 'TextWrap' => [ 'type' => 'string', 'enum' => [ 'NONE', 'WRAP', ], ], 'Theme' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ThemeName', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Version' => [ 'shape' => 'ThemeVersion', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'Type' => [ 'shape' => 'ThemeType', ], ], ], 'ThemeAlias' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AliasName' => [ 'shape' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'ThemeAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeAlias', ], 'max' => 100, ], 'ThemeConfiguration' => [ 'type' => 'structure', 'members' => [ 'DataColorPalette' => [ 'shape' => 'DataColorPalette', ], 'UIColorPalette' => [ 'shape' => 'UIColorPalette', ], 'Sheet' => [ 'shape' => 'SheetStyle', ], 'Typography' => [ 'shape' => 'Typography', ], ], ], 'ThemeError' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ThemeErrorType', ], 'Message' => [ 'shape' => 'NonEmptyString', ], ], ], 'ThemeErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeError', ], 'min' => 1, ], 'ThemeErrorType' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_FAILURE', ], ], 'ThemeName' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ThemeSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ThemeName', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'LatestVersionNumber' => [ 'shape' => 'VersionNumber', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ThemeSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeSummary', ], 'max' => 100, ], 'ThemeType' => [ 'type' => 'string', 'enum' => [ 'QUICKSIGHT', 'CUSTOM', 'ALL', ], ], 'ThemeVersion' => [ 'type' => 'structure', 'members' => [ 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Arn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], 'Errors' => [ 'shape' => 'ThemeErrorList', ], 'Status' => [ 'shape' => 'ResourceStatus', ], ], ], 'ThemeVersionSummary' => [ 'type' => 'structure', 'members' => [ 'VersionNumber' => [ 'shape' => 'VersionNumber', ], 'Arn' => [ 'shape' => 'Arn', ], 'Description' => [ 'shape' => 'VersionDescription', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'ResourceStatus', ], ], ], 'ThemeVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThemeVersionSummary', ], 'max' => 100, ], 'ThousandSeparatorOptions' => [ 'type' => 'structure', 'members' => [ 'Symbol' => [ 'shape' => 'NumericSeparatorSymbol', ], 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TileLayoutStyle' => [ 'type' => 'structure', 'members' => [ 'Gutter' => [ 'shape' => 'GutterStyle', ], 'Margin' => [ 'shape' => 'MarginStyle', ], ], ], 'TileStyle' => [ 'type' => 'structure', 'members' => [ 'Border' => [ 'shape' => 'BorderStyle', ], ], ], 'TimeBasedForecastProperties' => [ 'type' => 'structure', 'members' => [ 'PeriodsForward' => [ 'shape' => 'PeriodsForward', 'box' => true, ], 'PeriodsBackward' => [ 'shape' => 'PeriodsBackward', 'box' => true, ], 'UpperBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'LowerBoundary' => [ 'shape' => 'Double', 'box' => true, ], 'PredictionInterval' => [ 'shape' => 'PredictionInterval', 'box' => true, ], 'Seasonality' => [ 'shape' => 'Seasonality', 'box' => true, ], ], ], 'TimeEqualityFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Value' => [ 'shape' => 'Timestamp', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TimeGranularity' => [ 'type' => 'string', 'enum' => [ 'YEAR', 'QUARTER', 'MONTH', 'WEEK', 'DAY', 'HOUR', 'MINUTE', 'SECOND', 'MILLISECOND', ], ], 'TimeRangeDrillDownFilter' => [ 'type' => 'structure', 'required' => [ 'Column', 'RangeMinimum', 'RangeMaximum', 'TimeGranularity', ], 'members' => [ 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'RangeMinimum' => [ 'shape' => 'Timestamp', ], 'RangeMaximum' => [ 'shape' => 'Timestamp', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], ], ], 'TimeRangeFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'NullOption', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'IncludeMinimum' => [ 'shape' => 'Boolean', 'box' => true, ], 'IncludeMaximum' => [ 'shape' => 'Boolean', 'box' => true, ], 'RangeMinimumValue' => [ 'shape' => 'TimeRangeFilterValue', ], 'RangeMaximumValue' => [ 'shape' => 'TimeRangeFilterValue', ], 'NullOption' => [ 'shape' => 'FilterNullOption', ], 'ExcludePeriodConfiguration' => [ 'shape' => 'ExcludePeriodConfiguration', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TimeRangeFilterValue' => [ 'type' => 'structure', 'members' => [ 'StaticValue' => [ 'shape' => 'Timestamp', ], 'RollingDate' => [ 'shape' => 'RollingDateConfiguration', ], 'Parameter' => [ 'shape' => 'ParameterName', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooltipItem' => [ 'type' => 'structure', 'members' => [ 'FieldTooltipItem' => [ 'shape' => 'FieldTooltipItem', ], 'ColumnTooltipItem' => [ 'shape' => 'ColumnTooltipItem', ], ], ], 'TooltipItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TooltipItem', ], 'max' => 100, ], 'TooltipOptions' => [ 'type' => 'structure', 'members' => [ 'TooltipVisibility' => [ 'shape' => 'Visibility', ], 'SelectedTooltipType' => [ 'shape' => 'SelectedTooltipType', ], 'FieldBasedTooltip' => [ 'shape' => 'FieldBasedTooltip', ], ], ], 'TooltipTarget' => [ 'type' => 'string', 'enum' => [ 'BOTH', 'BAR', 'LINE', ], ], 'TooltipTitleType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIMARY_VALUE', ], ], 'TopBottomComputationType' => [ 'type' => 'string', 'enum' => [ 'TOP', 'BOTTOM', ], ], 'TopBottomFilter' => [ 'type' => 'structure', 'required' => [ 'FilterId', 'Column', 'AggregationSortConfigurations', ], 'members' => [ 'FilterId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'Limit' => [ 'shape' => 'Integer', 'box' => true, ], 'AggregationSortConfigurations' => [ 'shape' => 'AggregationSortConfigurationList', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'ParameterName' => [ 'shape' => 'ParameterName', ], 'DefaultFilterControlConfiguration' => [ 'shape' => 'DefaultFilterControlConfiguration', ], ], ], 'TopBottomMoversComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Time' => [ 'shape' => 'DimensionField', ], 'Category' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'MoverSize' => [ 'shape' => 'TopBottomMoversComputationMoverSize', ], 'SortOrder' => [ 'shape' => 'TopBottomSortOrder', ], 'Type' => [ 'shape' => 'TopBottomComputationType', ], ], ], 'TopBottomMoversComputationMoverSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'TopBottomRankedComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', 'Type', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Category' => [ 'shape' => 'DimensionField', ], 'Value' => [ 'shape' => 'MeasureField', ], 'ResultSize' => [ 'shape' => 'TopBottomRankedComputationResultSize', ], 'Type' => [ 'shape' => 'TopBottomComputationType', ], ], ], 'TopBottomRankedComputationResultSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'TopBottomSortOrder' => [ 'type' => 'string', 'enum' => [ 'PERCENT_DIFFERENCE', 'ABSOLUTE_DIFFERENCE', ], ], 'TopicCalculatedField' => [ 'type' => 'structure', 'required' => [ 'CalculatedFieldName', 'Expression', ], 'members' => [ 'CalculatedFieldName' => [ 'shape' => 'LimitedString', ], 'CalculatedFieldDescription' => [ 'shape' => 'LimitedString', ], 'Expression' => [ 'shape' => 'Expression', ], 'CalculatedFieldSynonyms' => [ 'shape' => 'Synonyms', ], 'IsIncludedInTopic' => [ 'shape' => 'Boolean', ], 'DisableIndexing' => [ 'shape' => 'NullableBoolean', ], 'ColumnDataRole' => [ 'shape' => 'ColumnDataRole', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'DefaultFormatting' => [ 'shape' => 'DefaultFormatting', ], 'Aggregation' => [ 'shape' => 'DefaultAggregation', ], 'ComparativeOrder' => [ 'shape' => 'ComparativeOrder', ], 'SemanticType' => [ 'shape' => 'SemanticType', ], 'AllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NotAllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NeverAggregateInFilter' => [ 'shape' => 'Boolean', ], 'CellValueSynonyms' => [ 'shape' => 'CellValueSynonyms', ], 'NonAdditive' => [ 'shape' => 'NullableBoolean', ], ], ], 'TopicCalculatedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicCalculatedField', ], ], 'TopicCategoryFilter' => [ 'type' => 'structure', 'members' => [ 'CategoryFilterFunction' => [ 'shape' => 'CategoryFilterFunction', ], 'CategoryFilterType' => [ 'shape' => 'CategoryFilterType', ], 'Constant' => [ 'shape' => 'TopicCategoryFilterConstant', ], 'Inverse' => [ 'shape' => 'Boolean', ], ], ], 'TopicCategoryFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], 'CollectiveConstant' => [ 'shape' => 'CollectiveConstant', ], ], 'sensitive' => true, ], 'TopicColumn' => [ 'type' => 'structure', 'required' => [ 'ColumnName', ], 'members' => [ 'ColumnName' => [ 'shape' => 'LimitedString', ], 'ColumnFriendlyName' => [ 'shape' => 'LimitedString', ], 'ColumnDescription' => [ 'shape' => 'LimitedString', ], 'ColumnSynonyms' => [ 'shape' => 'Synonyms', ], 'ColumnDataRole' => [ 'shape' => 'ColumnDataRole', ], 'Aggregation' => [ 'shape' => 'DefaultAggregation', ], 'IsIncludedInTopic' => [ 'shape' => 'Boolean', ], 'DisableIndexing' => [ 'shape' => 'NullableBoolean', ], 'ComparativeOrder' => [ 'shape' => 'ComparativeOrder', ], 'SemanticType' => [ 'shape' => 'SemanticType', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'AllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'NotAllowedAggregations' => [ 'shape' => 'AuthorSpecifiedAggregations', ], 'DefaultFormatting' => [ 'shape' => 'DefaultFormatting', ], 'NeverAggregateInFilter' => [ 'shape' => 'Boolean', ], 'CellValueSynonyms' => [ 'shape' => 'CellValueSynonyms', ], 'NonAdditive' => [ 'shape' => 'NullableBoolean', ], ], ], 'TopicColumns' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicColumn', ], ], 'TopicConstantValue' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'Value' => [ 'shape' => 'ConstantValueString', ], 'Minimum' => [ 'shape' => 'ConstantValueString', ], 'Maximum' => [ 'shape' => 'ConstantValueString', ], 'ValueList' => [ 'shape' => 'CollectiveConstantEntryList', ], ], ], 'TopicDateRangeFilter' => [ 'type' => 'structure', 'members' => [ 'Inclusive' => [ 'shape' => 'Boolean', ], 'Constant' => [ 'shape' => 'TopicRangeFilterConstant', ], ], ], 'TopicDetails' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ResourceName', ], 'Description' => [ 'shape' => 'LimitedString', ], 'UserExperienceVersion' => [ 'shape' => 'TopicUserExperienceVersion', ], 'DataSets' => [ 'shape' => 'Datasets', ], ], ], 'TopicFilter' => [ 'type' => 'structure', 'required' => [ 'FilterName', 'OperandFieldName', ], 'members' => [ 'FilterDescription' => [ 'shape' => 'LimitedString', ], 'FilterClass' => [ 'shape' => 'FilterClass', ], 'FilterName' => [ 'shape' => 'LimitedString', ], 'FilterSynonyms' => [ 'shape' => 'Synonyms', ], 'OperandFieldName' => [ 'shape' => 'LimitedString', ], 'FilterType' => [ 'shape' => 'NamedFilterType', ], 'CategoryFilter' => [ 'shape' => 'TopicCategoryFilter', ], 'NumericEqualityFilter' => [ 'shape' => 'TopicNumericEqualityFilter', ], 'NumericRangeFilter' => [ 'shape' => 'TopicNumericRangeFilter', ], 'DateRangeFilter' => [ 'shape' => 'TopicDateRangeFilter', ], 'RelativeDateFilter' => [ 'shape' => 'TopicRelativeDateFilter', ], ], ], 'TopicFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicFilter', ], ], 'TopicIR' => [ 'type' => 'structure', 'members' => [ 'Metrics' => [ 'shape' => 'TopicIRMetricList', ], 'GroupByList' => [ 'shape' => 'TopicIRGroupByList', ], 'Filters' => [ 'shape' => 'TopicIRFilterList', ], 'Sort' => [ 'shape' => 'TopicSortClause', ], 'ContributionAnalysis' => [ 'shape' => 'TopicIRContributionAnalysis', ], 'Visual' => [ 'shape' => 'VisualOptions', ], ], ], 'TopicIRComparisonMethod' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ComparisonMethodType', ], 'Period' => [ 'shape' => 'TopicTimeGranularity', ], 'WindowSize' => [ 'shape' => 'Integer', ], ], ], 'TopicIRContributionAnalysis' => [ 'type' => 'structure', 'members' => [ 'Factors' => [ 'shape' => 'ContributionAnalysisFactorsList', ], 'TimeRanges' => [ 'shape' => 'ContributionAnalysisTimeRanges', ], 'Direction' => [ 'shape' => 'ContributionAnalysisDirection', ], 'SortType' => [ 'shape' => 'ContributionAnalysisSortType', ], ], ], 'TopicIRFilterEntry' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRFilterOption', ], 'max' => 2000, ], 'TopicIRFilterFunction' => [ 'type' => 'string', 'enum' => [ 'CONTAINS', 'EXACT', 'STARTS_WITH', 'ENDS_WITH', 'CONTAINS_STRING', 'PREVIOUS', 'THIS', 'LAST', 'NEXT', 'NOW', ], ], 'TopicIRFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRFilterEntry', ], 'max' => 2000, ], 'TopicIRFilterOption' => [ 'type' => 'structure', 'members' => [ 'FilterType' => [ 'shape' => 'TopicIRFilterType', ], 'FilterClass' => [ 'shape' => 'FilterClass', ], 'OperandField' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'TopicIRFilterFunction', ], 'Constant' => [ 'shape' => 'TopicConstantValue', ], 'Inverse' => [ 'shape' => 'Boolean', ], 'NullFilter' => [ 'shape' => 'NullFilterOption', ], 'Aggregation' => [ 'shape' => 'AggType', ], 'AggregationFunctionParameters' => [ 'shape' => 'AggFunctionParamMap', ], 'AggregationPartitionBy' => [ 'shape' => 'AggregationPartitionByList', ], 'Range' => [ 'shape' => 'TopicConstantValue', ], 'Inclusive' => [ 'shape' => 'Boolean', ], 'TimeGranularity' => [ 'shape' => 'TimeGranularity', ], 'LastNextOffset' => [ 'shape' => 'TopicConstantValue', ], 'AggMetrics' => [ 'shape' => 'FilterAggMetricsList', ], 'TopBottomLimit' => [ 'shape' => 'TopicConstantValue', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], 'Anchor' => [ 'shape' => 'Anchor', ], ], ], 'TopicIRFilterType' => [ 'type' => 'string', 'enum' => [ 'CATEGORY_FILTER', 'NUMERIC_EQUALITY_FILTER', 'NUMERIC_RANGE_FILTER', 'DATE_RANGE_FILTER', 'RELATIVE_DATE_FILTER', 'TOP_BOTTOM_FILTER', 'EQUALS', 'RANK_LIMIT_FILTER', 'ACCEPT_ALL_FILTER', ], ], 'TopicIRGroupBy' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'Identifier', ], 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'Sort' => [ 'shape' => 'TopicSortClause', ], 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], 'NamedEntity' => [ 'shape' => 'NamedEntityRef', ], ], ], 'TopicIRGroupByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRGroupBy', ], 'max' => 2000, ], 'TopicIRMetric' => [ 'type' => 'structure', 'members' => [ 'MetricId' => [ 'shape' => 'Identifier', ], 'Function' => [ 'shape' => 'AggFunction', ], 'Operands' => [ 'shape' => 'OperandList', ], 'ComparisonMethod' => [ 'shape' => 'TopicIRComparisonMethod', ], 'Expression' => [ 'shape' => 'Expression', ], 'CalculatedFieldReferences' => [ 'shape' => 'CalculatedFieldReferenceList', ], 'DisplayFormat' => [ 'shape' => 'DisplayFormat', ], 'DisplayFormatOptions' => [ 'shape' => 'DisplayFormatOptions', ], 'NamedEntity' => [ 'shape' => 'NamedEntityRef', ], ], ], 'TopicIRMetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicIRMetric', ], 'max' => 2000, ], 'TopicId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[A-Za-z0-9-_.\\\\+]*$', ], 'TopicNamedEntities' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicNamedEntity', ], ], 'TopicNamedEntity' => [ 'type' => 'structure', 'required' => [ 'EntityName', ], 'members' => [ 'EntityName' => [ 'shape' => 'LimitedString', ], 'EntityDescription' => [ 'shape' => 'LimitedString', ], 'EntitySynonyms' => [ 'shape' => 'Synonyms', ], 'SemanticEntityType' => [ 'shape' => 'SemanticEntityType', ], 'Definition' => [ 'shape' => 'NamedEntityDefinitions', ], ], ], 'TopicNumericEqualityFilter' => [ 'type' => 'structure', 'members' => [ 'Constant' => [ 'shape' => 'TopicSingularFilterConstant', ], 'Aggregation' => [ 'shape' => 'NamedFilterAggType', ], ], ], 'TopicNumericRangeFilter' => [ 'type' => 'structure', 'members' => [ 'Inclusive' => [ 'shape' => 'Boolean', ], 'Constant' => [ 'shape' => 'TopicRangeFilterConstant', ], 'Aggregation' => [ 'shape' => 'NamedFilterAggType', ], ], ], 'TopicNumericSeparatorSymbol' => [ 'type' => 'string', 'enum' => [ 'COMMA', 'DOT', ], ], 'TopicRangeFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'RangeConstant' => [ 'shape' => 'RangeConstant', ], ], 'sensitive' => true, ], 'TopicRefreshDetails' => [ 'type' => 'structure', 'members' => [ 'RefreshArn' => [ 'shape' => 'Arn', ], 'RefreshId' => [ 'shape' => 'ResourceId', ], 'RefreshStatus' => [ 'shape' => 'TopicRefreshStatus', ], ], ], 'TopicRefreshSchedule' => [ 'type' => 'structure', 'required' => [ 'IsEnabled', 'BasedOnSpiceSchedule', ], 'members' => [ 'IsEnabled' => [ 'shape' => 'NullableBoolean', ], 'BasedOnSpiceSchedule' => [ 'shape' => 'Boolean', ], 'StartingAt' => [ 'shape' => 'Timestamp', ], 'Timezone' => [ 'shape' => 'LimitedString', ], 'RepeatAt' => [ 'shape' => 'LimitedString', ], 'TopicScheduleType' => [ 'shape' => 'TopicScheduleType', ], ], ], 'TopicRefreshScheduleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicRefreshScheduleSummary', ], ], 'TopicRefreshScheduleSummary' => [ 'type' => 'structure', 'members' => [ 'DatasetId' => [ 'shape' => 'LimitedString', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'DatasetName' => [ 'shape' => 'LimitedString', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'TopicRefreshStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'RUNNING', 'FAILED', 'COMPLETED', 'CANCELLED', ], ], 'TopicRelativeDateFilter' => [ 'type' => 'structure', 'members' => [ 'TimeGranularity' => [ 'shape' => 'TopicTimeGranularity', ], 'RelativeDateFilterFunction' => [ 'shape' => 'TopicRelativeDateFilterFunction', ], 'Constant' => [ 'shape' => 'TopicSingularFilterConstant', ], ], ], 'TopicRelativeDateFilterFunction' => [ 'type' => 'string', 'enum' => [ 'PREVIOUS', 'THIS', 'LAST', 'NEXT', 'NOW', ], ], 'TopicReviewedAnswer' => [ 'type' => 'structure', 'required' => [ 'AnswerId', 'DatasetArn', 'Question', ], 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnswerId' => [ 'shape' => 'AnswerId', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Question' => [ 'shape' => 'LimitedString', ], 'Mir' => [ 'shape' => 'TopicIR', ], 'PrimaryVisual' => [ 'shape' => 'TopicVisual', ], 'Template' => [ 'shape' => 'TopicTemplate', ], ], ], 'TopicReviewedAnswers' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicReviewedAnswer', ], ], 'TopicScheduleType' => [ 'type' => 'string', 'enum' => [ 'HOURLY', 'DAILY', 'WEEKLY', 'MONTHLY', ], ], 'TopicSingularFilterConstant' => [ 'type' => 'structure', 'members' => [ 'ConstantType' => [ 'shape' => 'ConstantType', ], 'SingularConstant' => [ 'shape' => 'LimitedString', ], ], 'sensitive' => true, ], 'TopicSortClause' => [ 'type' => 'structure', 'members' => [ 'Operand' => [ 'shape' => 'Identifier', ], 'SortDirection' => [ 'shape' => 'TopicSortDirection', ], ], ], 'TopicSortDirection' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'TopicSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicSummary', ], ], 'TopicSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'TopicId' => [ 'shape' => 'TopicId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'UserExperienceVersion' => [ 'shape' => 'TopicUserExperienceVersion', ], ], ], 'TopicTemplate' => [ 'type' => 'structure', 'members' => [ 'TemplateType' => [ 'shape' => 'LimitedString', ], 'Slots' => [ 'shape' => 'Slots', ], ], ], 'TopicTimeGranularity' => [ 'type' => 'string', 'enum' => [ 'SECOND', 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'QUARTER', 'YEAR', ], ], 'TopicUserExperienceVersion' => [ 'type' => 'string', 'enum' => [ 'LEGACY', 'NEW_READER_EXPERIENCE', ], ], 'TopicVisual' => [ 'type' => 'structure', 'members' => [ 'VisualId' => [ 'shape' => 'LimitedString', ], 'Role' => [ 'shape' => 'VisualRole', ], 'Ir' => [ 'shape' => 'TopicIR', ], 'SupportingVisuals' => [ 'shape' => 'TopicVisuals', ], ], ], 'TopicVisuals' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicVisual', ], ], 'TotalAggregationComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'MeasureField', ], ], ], 'TotalAggregationFunction' => [ 'type' => 'structure', 'members' => [ 'SimpleTotalAggregationFunction' => [ 'shape' => 'SimpleTotalAggregationFunction', ], ], ], 'TotalAggregationOption' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'TotalAggregationFunction', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'TotalAggregationFunction' => [ 'shape' => 'TotalAggregationFunction', ], ], ], 'TotalAggregationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TotalAggregationOption', ], 'max' => 200, ], 'TotalOptions' => [ 'type' => 'structure', 'members' => [ 'TotalsVisibility' => [ 'shape' => 'Visibility', ], 'Placement' => [ 'shape' => 'TableTotalsPlacement', ], 'ScrollStatus' => [ 'shape' => 'TableTotalsScrollStatus', ], 'CustomLabel' => [ 'shape' => 'String', ], 'TotalCellStyle' => [ 'shape' => 'TableCellStyle', ], 'TotalAggregationOptions' => [ 'shape' => 'TotalAggregationOptionList', ], ], ], 'TransformOperation' => [ 'type' => 'structure', 'members' => [ 'ProjectOperation' => [ 'shape' => 'ProjectOperation', ], 'FilterOperation' => [ 'shape' => 'FilterOperation', ], 'CreateColumnsOperation' => [ 'shape' => 'CreateColumnsOperation', ], 'RenameColumnOperation' => [ 'shape' => 'RenameColumnOperation', ], 'CastColumnTypeOperation' => [ 'shape' => 'CastColumnTypeOperation', ], 'TagColumnOperation' => [ 'shape' => 'TagColumnOperation', ], 'UntagColumnOperation' => [ 'shape' => 'UntagColumnOperation', ], 'OverrideDatasetParameterOperation' => [ 'shape' => 'OverrideDatasetParameterOperation', ], ], ], 'TransformOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformOperation', ], 'max' => 2048, 'min' => 1, ], 'TreeMapAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'TreeMapDimensionFieldList', ], 'Sizes' => [ 'shape' => 'TreeMapMeasureFieldList', ], 'Colors' => [ 'shape' => 'TreeMapMeasureFieldList', ], ], ], 'TreeMapConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'TreeMapFieldWells', ], 'SortConfiguration' => [ 'shape' => 'TreeMapSortConfiguration', ], 'GroupLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'SizeLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'ColorScale' => [ 'shape' => 'ColorScale', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'Tooltip' => [ 'shape' => 'TooltipOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'TreeMapDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 1, ], 'TreeMapFieldWells' => [ 'type' => 'structure', 'members' => [ 'TreeMapAggregatedFieldWells' => [ 'shape' => 'TreeMapAggregatedFieldWells', ], ], ], 'TreeMapMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'TreeMapSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'TreeMapSort' => [ 'shape' => 'FieldSortOptionsList', ], 'TreeMapGroupItemsLimitConfiguration' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'TreeMapVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'TreeMapConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'TrendArrowOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], ], ], 'TrinoParameters' => [ 'type' => 'structure', 'required' => [ 'Host', 'Port', 'Catalog', ], 'members' => [ 'Host' => [ 'shape' => 'Host', ], 'Port' => [ 'shape' => 'Port', ], 'Catalog' => [ 'shape' => 'Catalog', ], ], ], 'TwitterParameters' => [ 'type' => 'structure', 'required' => [ 'Query', 'MaxRows', ], 'members' => [ 'Query' => [ 'shape' => 'Query', ], 'MaxRows' => [ 'shape' => 'PositiveInteger', ], ], ], 'TypeCastFormat' => [ 'type' => 'string', 'max' => 32, ], 'TypeParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'LimitedString', ], 'value' => [ 'shape' => 'LimitedString', ], ], 'Typography' => [ 'type' => 'structure', 'members' => [ 'FontFamilies' => [ 'shape' => 'FontList', ], ], ], 'UIColorPalette' => [ 'type' => 'structure', 'members' => [ 'PrimaryForeground' => [ 'shape' => 'HexColor', ], 'PrimaryBackground' => [ 'shape' => 'HexColor', ], 'SecondaryForeground' => [ 'shape' => 'HexColor', ], 'SecondaryBackground' => [ 'shape' => 'HexColor', ], 'Accent' => [ 'shape' => 'HexColor', ], 'AccentForeground' => [ 'shape' => 'HexColor', ], 'Danger' => [ 'shape' => 'HexColor', ], 'DangerForeground' => [ 'shape' => 'HexColor', ], 'Warning' => [ 'shape' => 'HexColor', ], 'WarningForeground' => [ 'shape' => 'HexColor', ], 'Success' => [ 'shape' => 'HexColor', ], 'SuccessForeground' => [ 'shape' => 'HexColor', ], 'Dimension' => [ 'shape' => 'HexColor', ], 'DimensionForeground' => [ 'shape' => 'HexColor', ], 'Measure' => [ 'shape' => 'HexColor', ], 'MeasureForeground' => [ 'shape' => 'HexColor', ], ], ], 'URLOperationTemplate' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'URLTargetConfiguration' => [ 'type' => 'string', 'enum' => [ 'NEW_TAB', 'NEW_WINDOW', 'SAME_TAB', ], ], 'UnaggregatedField' => [ 'type' => 'structure', 'required' => [ 'FieldId', 'Column', ], 'members' => [ 'FieldId' => [ 'shape' => 'FieldId', ], 'Column' => [ 'shape' => 'ColumnIdentifier', ], 'FormatConfiguration' => [ 'shape' => 'FormatConfiguration', ], ], ], 'UnaggregatedFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnaggregatedField', ], 'max' => 200, ], 'UndefinedSpecifiedValueType' => [ 'type' => 'string', 'enum' => [ 'LEAST', 'MOST', ], ], 'UnicodeIcon' => [ 'type' => 'string', 'pattern' => '^[^\\u0000-\\u00FF]$', ], 'UniqueValuesComputation' => [ 'type' => 'structure', 'required' => [ 'ComputationId', ], 'members' => [ 'ComputationId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'String', ], 'Category' => [ 'shape' => 'DimensionField', ], ], ], 'UnlimitedPixelLength' => [ 'type' => 'string', ], 'UnsupportedPricingPlanException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'UnsupportedUserEditionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], 'RequestId' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'UntagColumnOperation' => [ 'type' => 'structure', 'required' => [ 'ColumnName', 'TagNames', ], 'members' => [ 'ColumnName' => [ 'shape' => 'ColumnName', ], 'TagNames' => [ 'shape' => 'ColumnTagNames', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', 'location' => 'uri', 'locationName' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'keys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAccountCustomizationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AccountCustomization', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'querystring', 'locationName' => 'namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], ], ], 'UpdateAccountCustomizationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', ], 'AccountCustomization' => [ 'shape' => 'AccountCustomization', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAccountSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DefaultNamespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DefaultNamespace' => [ 'shape' => 'Namespace', ], 'NotificationEmail' => [ 'shape' => 'String', ], 'TerminationProtectionEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdateAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAnalysisPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateAnalysisPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'AnalysisArn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AnalysisId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'AnalysisId', ], 'Name' => [ 'shape' => 'AnalysisName', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'SourceEntity' => [ 'shape' => 'AnalysisSourceEntity', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'AnalysisDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'AnalysisId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'UpdateStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDashboardLinksRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'LinkEntities', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'UpdateDashboardLinksResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'LinkEntities' => [ 'shape' => 'LinkEntityArnList', ], ], ], 'UpdateDashboardPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'GrantLinkPermissions' => [ 'shape' => 'UpdateLinkPermissionList', ], 'RevokeLinkPermissions' => [ 'shape' => 'UpdateLinkPermissionList', ], ], ], 'UpdateDashboardPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'LinkSharingConfiguration' => [ 'shape' => 'LinkSharingConfiguration', ], ], ], 'UpdateDashboardPublishedVersionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'VersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'VersionNumber' => [ 'shape' => 'VersionNumber', 'location' => 'uri', 'locationName' => 'VersionNumber', ], ], ], 'UpdateDashboardPublishedVersionResponse' => [ 'type' => 'structure', 'members' => [ 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'DashboardArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDashboardRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DashboardId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'DashboardId', ], 'Name' => [ 'shape' => 'DashboardName', ], 'SourceEntity' => [ 'shape' => 'DashboardSourceEntity', ], 'Parameters' => [ 'shape' => 'Parameters', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'DashboardPublishOptions' => [ 'shape' => 'DashboardPublishOptions', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Definition' => [ 'shape' => 'DashboardVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateDashboardResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'DashboardId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateDataSetPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateDataSetPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetArn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSetId', 'Name', 'PhysicalTableMap', 'ImportMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'PhysicalTableMap' => [ 'shape' => 'PhysicalTableMap', ], 'LogicalTableMap' => [ 'shape' => 'LogicalTableMap', ], 'ImportMode' => [ 'shape' => 'DataSetImportMode', ], 'ColumnGroups' => [ 'shape' => 'ColumnGroupList', ], 'FieldFolders' => [ 'shape' => 'FieldFolderMap', ], 'RowLevelPermissionDataSet' => [ 'shape' => 'RowLevelPermissionDataSet', ], 'RowLevelPermissionTagConfiguration' => [ 'shape' => 'RowLevelPermissionTagConfiguration', ], 'ColumnLevelPermissionRules' => [ 'shape' => 'ColumnLevelPermissionRuleList', ], 'DataSetUsageConfiguration' => [ 'shape' => 'DataSetUsageConfiguration', ], 'DatasetParameters' => [ 'shape' => 'DatasetParameterList', ], ], ], 'UpdateDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSetId' => [ 'shape' => 'ResourceId', ], 'IngestionArn' => [ 'shape' => 'Arn', ], 'IngestionId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSourcePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateDataSourcePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceArn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'DataSourceId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'DataSourceId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'DataSourceParameters' => [ 'shape' => 'DataSourceParameters', ], 'Credentials' => [ 'shape' => 'DataSourceCredentials', ], 'VpcConnectionProperties' => [ 'shape' => 'VpcConnectionProperties', ], 'SslProperties' => [ 'shape' => 'SslProperties', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'DataSourceId' => [ 'shape' => 'ResourceId', ], 'UpdateStatus' => [ 'shape' => 'ResourceStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateFolderPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'GrantPermissions' => [ 'shape' => 'ResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'ResourcePermissionList', ], ], ], 'UpdateFolderPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateFolderRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'FolderId', 'Name', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', 'location' => 'uri', 'locationName' => 'FolderId', ], 'Name' => [ 'shape' => 'FolderName', ], ], ], 'UpdateFolderResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'Arn' => [ 'shape' => 'Arn', ], 'FolderId' => [ 'shape' => 'RestrictiveResourceId', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'AwsAccountId', 'Namespace', ], 'members' => [ 'GroupName' => [ 'shape' => 'GroupName', 'location' => 'uri', 'locationName' => 'GroupName', ], 'Description' => [ 'shape' => 'GroupDescription', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Group' => [ 'shape' => 'Group', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIAMPolicyAssignmentRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'AssignmentName', 'Namespace', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', 'location' => 'uri', 'locationName' => 'AssignmentName', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], ], ], 'UpdateIAMPolicyAssignmentResponse' => [ 'type' => 'structure', 'members' => [ 'AssignmentName' => [ 'shape' => 'IAMPolicyAssignmentName', ], 'AssignmentId' => [ 'shape' => 'String', ], 'PolicyArn' => [ 'shape' => 'Arn', ], 'Identities' => [ 'shape' => 'IdentityMap', ], 'AssignmentStatus' => [ 'shape' => 'AssignmentStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIdentityPropagationConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'Service', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Service' => [ 'shape' => 'ServiceType', 'location' => 'uri', 'locationName' => 'Service', ], 'AuthorizedTargets' => [ 'shape' => 'AuthorizedTargetsList', ], ], ], 'UpdateIdentityPropagationConfigResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateIpRestrictionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'IpRestrictionRuleMap' => [ 'shape' => 'IpRestrictionRuleMap', ], 'VpcIdRestrictionRuleMap' => [ 'shape' => 'VpcIdRestrictionRuleMap', ], 'VpcEndpointIdRestrictionRuleMap' => [ 'shape' => 'VpcEndpointIdRestrictionRuleMap', ], 'Enabled' => [ 'shape' => 'NullableBoolean', ], ], ], 'UpdateIpRestrictionResponse' => [ 'type' => 'structure', 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateKeyRegistrationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'KeyRegistration', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'KeyRegistration' => [ 'shape' => 'KeyRegistration', ], ], ], 'UpdateKeyRegistrationResponse' => [ 'type' => 'structure', 'members' => [ 'FailedKeyRegistration' => [ 'shape' => 'FailedKeyRegistrationEntries', ], 'SuccessfulKeyRegistration' => [ 'shape' => 'SuccessfulKeyRegistrationEntries', ], 'RequestId' => [ 'shape' => 'NonEmptyString', ], ], ], 'UpdateLinkPermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 100, ], 'UpdatePublicSharingSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'PublicSharingEnabled' => [ 'shape' => 'Boolean', ], ], ], 'UpdatePublicSharingSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'DataSetId', 'AwsAccountId', 'Schedule', ], 'members' => [ 'DataSetId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'DataSetId', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Schedule' => [ 'shape' => 'RefreshSchedule', ], ], ], 'UpdateRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], 'ScheduleId' => [ 'shape' => 'String', ], 'Arn' => [ 'shape' => 'Arn', ], ], ], 'UpdateResourcePermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePermission', ], 'max' => 100, ], 'UpdateRoleCustomPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CustomPermissionsName', 'Role', 'AwsAccountId', 'Namespace', ], 'members' => [ 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'Role' => [ 'shape' => 'Role', 'location' => 'uri', 'locationName' => 'Role', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], ], ], 'UpdateRoleCustomPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', ], ], ], 'UpdateSPICECapacityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'PurchaseMode', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'PurchaseMode' => [ 'shape' => 'PurchaseMode', ], ], ], 'UpdateSPICECapacityConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateTemplateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', 'AliasName', 'TemplateVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'TemplateVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateTemplateAliasResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateAlias' => [ 'shape' => 'TemplateAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTemplatePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateTemplatePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TemplateId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'TemplateId', ], 'SourceEntity' => [ 'shape' => 'TemplateSourceEntity', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Name' => [ 'shape' => 'TemplateName', ], 'Definition' => [ 'shape' => 'TemplateVersionDefinition', ], 'ValidationStrategy' => [ 'shape' => 'ValidationStrategy', ], ], ], 'UpdateTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'TemplateId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateThemeAliasRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'AliasName', 'ThemeVersionNumber', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'AliasName' => [ 'shape' => 'AliasName', 'location' => 'uri', 'locationName' => 'AliasName', ], 'ThemeVersionNumber' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateThemeAliasResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeAlias' => [ 'shape' => 'ThemeAlias', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateThemePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateThemePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'ThemeArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateThemeRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'ThemeId', 'BaseThemeId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', 'location' => 'uri', 'locationName' => 'ThemeId', ], 'Name' => [ 'shape' => 'ThemeName', ], 'BaseThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'VersionDescription' => [ 'shape' => 'VersionDescription', ], 'Configuration' => [ 'shape' => 'ThemeConfiguration', ], ], ], 'UpdateThemeResponse' => [ 'type' => 'structure', 'members' => [ 'ThemeId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Arn' => [ 'shape' => 'Arn', ], 'VersionArn' => [ 'shape' => 'Arn', ], 'CreationStatus' => [ 'shape' => 'ResourceStatus', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'GrantPermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], 'RevokePermissions' => [ 'shape' => 'UpdateResourcePermissionList', ], ], ], 'UpdateTopicPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'Permissions' => [ 'shape' => 'ResourcePermissionList', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicRefreshScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'DatasetId', 'RefreshSchedule', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'DatasetId' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'DatasetId', ], 'RefreshSchedule' => [ 'shape' => 'TopicRefreshSchedule', ], ], ], 'UpdateTopicRefreshScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'TopicArn' => [ 'shape' => 'Arn', ], 'DatasetArn' => [ 'shape' => 'Arn', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], 'RequestId' => [ 'shape' => 'String', ], ], ], 'UpdateTopicRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'TopicId', 'Topic', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'TopicId' => [ 'shape' => 'TopicId', 'location' => 'uri', 'locationName' => 'TopicId', ], 'Topic' => [ 'shape' => 'TopicDetails', ], ], ], 'UpdateTopicResponse' => [ 'type' => 'structure', 'members' => [ 'TopicId' => [ 'shape' => 'TopicId', ], 'Arn' => [ 'shape' => 'Arn', ], 'RefreshArn' => [ 'shape' => 'Arn', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserName', 'AwsAccountId', 'Namespace', 'Email', 'Role', ], 'members' => [ 'UserName' => [ 'shape' => 'UserName', 'location' => 'uri', 'locationName' => 'UserName', ], 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'Namespace' => [ 'shape' => 'Namespace', 'location' => 'uri', 'locationName' => 'Namespace', ], 'Email' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'UserRole', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'UnapplyCustomPermissions' => [ 'shape' => 'Boolean', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'CustomFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], ], ], 'UpdateUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UpdateVPCConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'AwsAccountId', 'VPCConnectionId', 'Name', 'SubnetIds', 'SecurityGroupIds', 'RoleArn', ], 'members' => [ 'AwsAccountId' => [ 'shape' => 'AwsAccountId', 'location' => 'uri', 'locationName' => 'AwsAccountId', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', 'location' => 'uri', 'locationName' => 'VPCConnectionId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'DnsResolverList', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateVPCConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'UpdateStatus' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'RequestId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'StatusCode', 'location' => 'statusCode', ], ], ], 'UploadSettings' => [ 'type' => 'structure', 'members' => [ 'Format' => [ 'shape' => 'FileFormat', ], 'StartFromRow' => [ 'shape' => 'PositiveInteger', 'box' => true, ], 'ContainsHeader' => [ 'shape' => 'Boolean', 'box' => true, ], 'TextQualifier' => [ 'shape' => 'TextQualifier', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'UserName' => [ 'shape' => 'UserName', ], 'Email' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'UserRole', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Active' => [ 'shape' => 'Boolean', ], 'PrincipalId' => [ 'shape' => 'String', ], 'CustomPermissionsName' => [ 'shape' => 'RoleName', ], 'ExternalLoginFederationProviderType' => [ 'shape' => 'String', ], 'ExternalLoginFederationProviderUrl' => [ 'shape' => 'String', ], 'ExternalLoginId' => [ 'shape' => 'String', ], ], ], 'UserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'UserName' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'UserRole' => [ 'type' => 'string', 'enum' => [ 'ADMIN', 'AUTHOR', 'READER', 'RESTRICTED_AUTHOR', 'RESTRICTED_READER', 'ADMIN_PRO', 'AUTHOR_PRO', 'READER_PRO', ], ], 'VPCConnection' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResourceName', ], 'VPCId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'NetworkInterfaces' => [ 'shape' => 'NetworkInterfaceList', ], 'RoleArn' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'VPCConnectionAvailabilityStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNAVAILABLE', 'PARTIALLY_AVAILABLE', ], ], 'VPCConnectionResourceIdRestricted' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'VPCConnectionResourceIdUnrestricted' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'VPCConnectionResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'CREATION_SUCCESSFUL', 'CREATION_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_FAILED', 'DELETED', ], ], 'VPCConnectionSummary' => [ 'type' => 'structure', 'members' => [ 'VPCConnectionId' => [ 'shape' => 'VPCConnectionResourceIdUnrestricted', ], 'Arn' => [ 'shape' => 'Arn', ], 'Name' => [ 'shape' => 'ResourceName', ], 'VPCId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdList', ], 'DnsResolvers' => [ 'shape' => 'StringList', ], 'Status' => [ 'shape' => 'VPCConnectionResourceStatus', ], 'AvailabilityStatus' => [ 'shape' => 'VPCConnectionAvailabilityStatus', ], 'NetworkInterfaces' => [ 'shape' => 'NetworkInterfaceList', ], 'RoleArn' => [ 'shape' => 'String', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'VPCConnectionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VPCConnectionSummary', ], ], 'ValidationStrategy' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'ValidationStrategyMode', ], ], ], 'ValidationStrategyMode' => [ 'type' => 'string', 'enum' => [ 'STRICT', 'LENIENT', ], ], 'ValueWhenUnsetOption' => [ 'type' => 'string', 'enum' => [ 'RECOMMENDED_VALUE', 'NULL', ], ], 'VersionDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'VersionNumber' => [ 'type' => 'long', 'min' => 1, ], 'VerticalTextAlignment' => [ 'type' => 'string', 'enum' => [ 'TOP', 'MIDDLE', 'BOTTOM', 'AUTO', ], ], 'Visibility' => [ 'type' => 'string', 'enum' => [ 'HIDDEN', 'VISIBLE', ], ], 'VisiblePanelColumns' => [ 'type' => 'long', 'max' => 10, 'min' => 1, ], 'VisiblePanelRows' => [ 'type' => 'long', 'max' => 10, 'min' => 1, ], 'VisibleRangeOptions' => [ 'type' => 'structure', 'members' => [ 'PercentRange' => [ 'shape' => 'PercentVisibleRange', ], ], ], 'Visual' => [ 'type' => 'structure', 'members' => [ 'TableVisual' => [ 'shape' => 'TableVisual', ], 'PivotTableVisual' => [ 'shape' => 'PivotTableVisual', ], 'BarChartVisual' => [ 'shape' => 'BarChartVisual', ], 'KPIVisual' => [ 'shape' => 'KPIVisual', ], 'PieChartVisual' => [ 'shape' => 'PieChartVisual', ], 'GaugeChartVisual' => [ 'shape' => 'GaugeChartVisual', ], 'LineChartVisual' => [ 'shape' => 'LineChartVisual', ], 'HeatMapVisual' => [ 'shape' => 'HeatMapVisual', ], 'TreeMapVisual' => [ 'shape' => 'TreeMapVisual', ], 'GeospatialMapVisual' => [ 'shape' => 'GeospatialMapVisual', ], 'FilledMapVisual' => [ 'shape' => 'FilledMapVisual', ], 'FunnelChartVisual' => [ 'shape' => 'FunnelChartVisual', ], 'ScatterPlotVisual' => [ 'shape' => 'ScatterPlotVisual', ], 'ComboChartVisual' => [ 'shape' => 'ComboChartVisual', ], 'BoxPlotVisual' => [ 'shape' => 'BoxPlotVisual', ], 'WaterfallVisual' => [ 'shape' => 'WaterfallVisual', ], 'HistogramVisual' => [ 'shape' => 'HistogramVisual', ], 'WordCloudVisual' => [ 'shape' => 'WordCloudVisual', ], 'InsightVisual' => [ 'shape' => 'InsightVisual', ], 'SankeyDiagramVisual' => [ 'shape' => 'SankeyDiagramVisual', ], 'CustomContentVisual' => [ 'shape' => 'CustomContentVisual', ], 'EmptyVisual' => [ 'shape' => 'EmptyVisual', ], 'RadarChartVisual' => [ 'shape' => 'RadarChartVisual', ], ], ], 'VisualAxisSortOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'VisualCustomAction' => [ 'type' => 'structure', 'required' => [ 'CustomActionId', 'Name', 'Trigger', 'ActionOperations', ], 'members' => [ 'CustomActionId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Name' => [ 'shape' => 'VisualCustomActionName', ], 'Status' => [ 'shape' => 'WidgetStatus', ], 'Trigger' => [ 'shape' => 'VisualCustomActionTrigger', ], 'ActionOperations' => [ 'shape' => 'VisualCustomActionOperationList', ], ], ], 'VisualCustomActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisualCustomAction', ], 'max' => 10, ], 'VisualCustomActionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'VisualCustomActionOperation' => [ 'type' => 'structure', 'members' => [ 'FilterOperation' => [ 'shape' => 'CustomActionFilterOperation', ], 'NavigationOperation' => [ 'shape' => 'CustomActionNavigationOperation', ], 'URLOperation' => [ 'shape' => 'CustomActionURLOperation', ], 'SetParametersOperation' => [ 'shape' => 'CustomActionSetParametersOperation', ], ], ], 'VisualCustomActionOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisualCustomActionOperation', ], 'max' => 2, 'min' => 1, ], 'VisualCustomActionTrigger' => [ 'type' => 'string', 'enum' => [ 'DATA_POINT_CLICK', 'DATA_POINT_MENU', ], ], 'VisualInteractionOptions' => [ 'type' => 'structure', 'members' => [ 'VisualMenuOption' => [ 'shape' => 'VisualMenuOption', ], 'ContextMenuOption' => [ 'shape' => 'ContextMenuOption', ], ], ], 'VisualList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Visual', ], 'max' => 50, ], 'VisualMenuOption' => [ 'type' => 'structure', 'members' => [ 'AvailabilityStatus' => [ 'shape' => 'DashboardBehavior', ], ], ], 'VisualOptions' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'LimitedString', ], ], ], 'VisualPalette' => [ 'type' => 'structure', 'members' => [ 'ChartColor' => [ 'shape' => 'HexColor', ], 'ColorMap' => [ 'shape' => 'DataPathColorList', ], ], ], 'VisualRole' => [ 'type' => 'string', 'enum' => [ 'PRIMARY', 'COMPLIMENTARY', 'MULTI_INTENT', 'FALLBACK', 'FRAGMENT', ], ], 'VisualSubtitleLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FormatText' => [ 'shape' => 'LongFormatText', ], ], ], 'VisualTitleLabelOptions' => [ 'type' => 'structure', 'members' => [ 'Visibility' => [ 'shape' => 'Visibility', ], 'FormatText' => [ 'shape' => 'ShortFormatText', ], ], ], 'VpcConnectionProperties' => [ 'type' => 'structure', 'required' => [ 'VpcConnectionArn', ], 'members' => [ 'VpcConnectionArn' => [ 'shape' => 'Arn', ], ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'VpcEndpointIdRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'VpcEndpointIdRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'VpcEndpointId', ], 'value' => [ 'shape' => 'VpcEndpointIdRestrictionRuleDescription', ], ], 'VpcId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpc-[0-9a-z]*$', ], 'VpcIdRestrictionRuleDescription' => [ 'type' => 'string', 'max' => 150, 'min' => 0, ], 'VpcIdRestrictionRuleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'VpcId', ], 'value' => [ 'shape' => 'VpcIdRestrictionRuleDescription', ], ], 'Warehouse' => [ 'type' => 'string', 'max' => 128, ], 'WaterfallChartAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'Categories' => [ 'shape' => 'DimensionFieldList', ], 'Values' => [ 'shape' => 'MeasureFieldList', ], 'Breakdowns' => [ 'shape' => 'DimensionFieldList', ], ], ], 'WaterfallChartColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'GroupColorConfiguration' => [ 'shape' => 'WaterfallChartGroupColorConfiguration', ], ], ], 'WaterfallChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'WaterfallChartFieldWells', ], 'SortConfiguration' => [ 'shape' => 'WaterfallChartSortConfiguration', ], 'WaterfallChartOptions' => [ 'shape' => 'WaterfallChartOptions', ], 'CategoryAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'CategoryAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'PrimaryYAxisLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'PrimaryYAxisDisplayOptions' => [ 'shape' => 'AxisDisplayOptions', ], 'Legend' => [ 'shape' => 'LegendOptions', ], 'DataLabels' => [ 'shape' => 'DataLabelOptions', ], 'VisualPalette' => [ 'shape' => 'VisualPalette', ], 'ColorConfiguration' => [ 'shape' => 'WaterfallChartColorConfiguration', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'WaterfallChartFieldWells' => [ 'type' => 'structure', 'members' => [ 'WaterfallChartAggregatedFieldWells' => [ 'shape' => 'WaterfallChartAggregatedFieldWells', ], ], ], 'WaterfallChartGroupColorConfiguration' => [ 'type' => 'structure', 'members' => [ 'PositiveBarColor' => [ 'shape' => 'HexColor', ], 'NegativeBarColor' => [ 'shape' => 'HexColor', ], 'TotalBarColor' => [ 'shape' => 'HexColor', ], ], ], 'WaterfallChartOptions' => [ 'type' => 'structure', 'members' => [ 'TotalBarLabel' => [ 'shape' => 'String', ], ], ], 'WaterfallChartSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], 'BreakdownItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], ], ], 'WaterfallVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'WaterfallChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'WhatIfPointScenario' => [ 'type' => 'structure', 'required' => [ 'Date', 'Value', ], 'members' => [ 'Date' => [ 'shape' => 'Timestamp', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'WhatIfRangeScenario' => [ 'type' => 'structure', 'required' => [ 'StartDate', 'EndDate', 'Value', ], 'members' => [ 'StartDate' => [ 'shape' => 'Timestamp', ], 'EndDate' => [ 'shape' => 'Timestamp', ], 'Value' => [ 'shape' => 'Double', ], ], ], 'WidgetStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'WordCloudAggregatedFieldWells' => [ 'type' => 'structure', 'members' => [ 'GroupBy' => [ 'shape' => 'WordCloudDimensionFieldList', ], 'Size' => [ 'shape' => 'WordCloudMeasureFieldList', ], ], ], 'WordCloudChartConfiguration' => [ 'type' => 'structure', 'members' => [ 'FieldWells' => [ 'shape' => 'WordCloudFieldWells', ], 'SortConfiguration' => [ 'shape' => 'WordCloudSortConfiguration', ], 'CategoryLabelOptions' => [ 'shape' => 'ChartAxisLabelOptions', ], 'WordCloudOptions' => [ 'shape' => 'WordCloudOptions', ], 'Interactions' => [ 'shape' => 'VisualInteractionOptions', ], ], ], 'WordCloudCloudLayout' => [ 'type' => 'string', 'enum' => [ 'FLUID', 'NORMAL', ], ], 'WordCloudDimensionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DimensionField', ], 'max' => 10, ], 'WordCloudFieldWells' => [ 'type' => 'structure', 'members' => [ 'WordCloudAggregatedFieldWells' => [ 'shape' => 'WordCloudAggregatedFieldWells', ], ], ], 'WordCloudMaximumStringLength' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'WordCloudMeasureFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeasureField', ], 'max' => 1, ], 'WordCloudOptions' => [ 'type' => 'structure', 'members' => [ 'WordOrientation' => [ 'shape' => 'WordCloudWordOrientation', ], 'WordScaling' => [ 'shape' => 'WordCloudWordScaling', ], 'CloudLayout' => [ 'shape' => 'WordCloudCloudLayout', ], 'WordCasing' => [ 'shape' => 'WordCloudWordCasing', ], 'WordPadding' => [ 'shape' => 'WordCloudWordPadding', ], 'MaximumStringLength' => [ 'shape' => 'WordCloudMaximumStringLength', ], ], ], 'WordCloudSortConfiguration' => [ 'type' => 'structure', 'members' => [ 'CategoryItemsLimit' => [ 'shape' => 'ItemsLimitConfiguration', ], 'CategorySort' => [ 'shape' => 'FieldSortOptionsList', ], ], ], 'WordCloudVisual' => [ 'type' => 'structure', 'required' => [ 'VisualId', ], 'members' => [ 'VisualId' => [ 'shape' => 'ShortRestrictiveResourceId', ], 'Title' => [ 'shape' => 'VisualTitleLabelOptions', ], 'Subtitle' => [ 'shape' => 'VisualSubtitleLabelOptions', ], 'ChartConfiguration' => [ 'shape' => 'WordCloudChartConfiguration', ], 'Actions' => [ 'shape' => 'VisualCustomActionList', ], 'ColumnHierarchies' => [ 'shape' => 'ColumnHierarchyList', ], ], ], 'WordCloudWordCasing' => [ 'type' => 'string', 'enum' => [ 'LOWER_CASE', 'EXISTING_CASE', ], ], 'WordCloudWordOrientation' => [ 'type' => 'string', 'enum' => [ 'HORIZONTAL', 'HORIZONTAL_AND_VERTICAL', ], ], 'WordCloudWordPadding' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SMALL', 'MEDIUM', 'LARGE', ], ], 'WordCloudWordScaling' => [ 'type' => 'string', 'enum' => [ 'EMPHASIZE', 'NORMAL', ], ], 'WorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'YAxisOptions' => [ 'type' => 'structure', 'required' => [ 'YAxis', ], 'members' => [ 'YAxis' => [ 'shape' => 'SingleYAxisOption', ], ], ], 'boolean' => [ 'type' => 'boolean', ], ],]; diff --git a/src/data/quicksight/2018-04-01/docs-2.json b/src/data/quicksight/2018-04-01/docs-2.json index f332bedaf6..423e01c81a 100644 --- a/src/data/quicksight/2018-04-01/docs-2.json +++ b/src/data/quicksight/2018-04-01/docs-2.json @@ -3610,6 +3610,12 @@ "DashboardVersion$DataSetArns": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

" } }, + "DataSetCalculatedFieldExpression": { + "base": null, + "refs": { + "CalculatedColumn$Expression": "

An expression that defines the calculated column.

" + } + }, "DataSetConfiguration": { "base": "

Dataset configuration.

", "refs": { @@ -5231,7 +5237,6 @@ "Expression": { "base": null, "refs": { - "CalculatedColumn$Expression": "

An expression that defines the calculated column.

", "CalculatedMeasureField$Expression": "

The expression in the table calculation.

", "ConditionalFormattingCustomIconCondition$Expression": "

The expression that determines the condition of the icon set.

", "ConditionalFormattingGradientColor$Expression": "

The expression that determines the formatting configuration for gradient color.

", diff --git a/src/data/quicksight/2018-04-01/docs-2.json.php b/src/data/quicksight/2018-04-01/docs-2.json.php index 099bc6d743..d696ac69b9 100644 --- a/src/data/quicksight/2018-04-01/docs-2.json.php +++ b/src/data/quicksight/2018-04-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

', 'operations' => [ 'BatchCreateTopicReviewedAnswer' => '

Creates new reviewed answers for a Q Topic.

', 'BatchDeleteTopicReviewedAnswer' => '

Deletes reviewed answers for Q Topic.

', 'CancelIngestion' => '

Cancels an ongoing ingestion of data into SPICE.

', 'CreateAccountCustomization' => '

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.

', 'CreateAccountSubscription' => '

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.

', 'CreateAnalysis' => '

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

', 'CreateDashboard' => '

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.

', 'CreateDataSet' => '

Creates a dataset. This operation doesn\'t support datasets that include uploaded files as a source.

', 'CreateDataSource' => '

Creates a data source.

', 'CreateFolder' => '

Creates an empty shared folder.

', 'CreateFolderMembership' => '

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

', 'CreateGroup' => '

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.

', 'CreateGroupMembership' => '

Adds an Amazon QuickSight user to an Amazon QuickSight group.

', 'CreateIAMPolicyAssignment' => '

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

', 'CreateIngestion' => '

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

', 'CreateNamespace' => '

(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 Services Support.

', 'CreateRefreshSchedule' => '

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

', 'CreateRoleMembership' => '

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

', 'CreateTemplate' => '

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.

', 'CreateTemplateAlias' => '

Creates a template alias for a template.

', 'CreateTheme' => '

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'CreateThemeAlias' => '

Creates a theme alias for a theme.

', 'CreateTopic' => '

Creates a new Q topic.

', 'CreateTopicRefreshSchedule' => '

Creates a topic refresh schedule.

', 'CreateVPCConnection' => '

Creates a new VPC connection.

', 'DeleteAccountCustomization' => '

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

', 'DeleteAccountSubscription' => '

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.

', 'DeleteAnalysis' => '

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.

', 'DeleteDashboard' => '

Deletes a dashboard.

', 'DeleteDataSet' => '

Deletes a dataset.

', 'DeleteDataSetRefreshProperties' => '

Deletes the dataset refresh properties of the dataset.

', 'DeleteDataSource' => '

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

', 'DeleteFolder' => '

Deletes an empty folder.

', 'DeleteFolderMembership' => '

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

', 'DeleteGroup' => '

Removes a user group from Amazon QuickSight.

', 'DeleteGroupMembership' => '

Removes a user from a group so that the user is no longer a member of the group.

', 'DeleteIAMPolicyAssignment' => '

Deletes an existing IAM policy assignment.

', 'DeleteIdentityPropagationConfig' => '

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.

', 'DeleteNamespace' => '

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

', 'DeleteRefreshSchedule' => '

Deletes a refresh schedule from a dataset.

', 'DeleteRoleCustomPermission' => '

Removes custom permissions from the role.

', 'DeleteRoleMembership' => '

Removes a group from a role.

', 'DeleteTemplate' => '

Deletes a template.

', 'DeleteTemplateAlias' => '

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

', 'DeleteTheme' => '

Deletes a theme.

', 'DeleteThemeAlias' => '

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

', 'DeleteTopic' => '

Deletes a topic.

', 'DeleteTopicRefreshSchedule' => '

Deletes a topic refresh schedule.

', 'DeleteUser' => '

Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that\'s making the call. The IAM user isn\'t deleted as a result of this call.

', 'DeleteUserByPrincipalId' => '

Deletes a user identified by its principal ID.

', 'DeleteVPCConnection' => '

Deletes a VPC connection.

', 'DescribeAccountCustomization' => '

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.

', 'DescribeAccountSettings' => '

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

', 'DescribeAccountSubscription' => '

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.

', 'DescribeAnalysis' => '

Provides a summary of the metadata for an analysis.

', 'DescribeAnalysisDefinition' => '

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

', 'DescribeAnalysisPermissions' => '

Provides the read and write permissions for an analysis.

', 'DescribeAssetBundleExportJob' => '

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets\' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

', 'DescribeAssetBundleImportJob' => '

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

', 'DescribeDashboard' => '

Provides a summary for a dashboard.

', 'DescribeDashboardDefinition' => '

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

', 'DescribeDashboardPermissions' => '

Describes read and write permissions for a dashboard.

', 'DescribeDashboardSnapshotJob' => '

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

', 'DescribeDashboardSnapshotJobResult' => '

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..

', 'DescribeDataSet' => '

Describes a dataset. This operation doesn\'t support datasets that include uploaded files as a source.

', 'DescribeDataSetPermissions' => '

Describes the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

', 'DescribeDataSetRefreshProperties' => '

Describes the refresh properties of a dataset.

', 'DescribeDataSource' => '

Describes a data source.

', 'DescribeDataSourcePermissions' => '

Describes the resource permissions for a data source.

', 'DescribeFolder' => '

Describes a folder.

', 'DescribeFolderPermissions' => '

Describes permissions for a folder.

', 'DescribeFolderResolvedPermissions' => '

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

', 'DescribeGroup' => '

Returns an Amazon QuickSight group\'s description and Amazon Resource Name (ARN).

', 'DescribeGroupMembership' => '

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

', 'DescribeIAMPolicyAssignment' => '

Describes an existing IAM policy assignment, as specified by the assignment name.

', 'DescribeIngestion' => '

Describes a SPICE ingestion.

', 'DescribeIpRestriction' => '

Provides a summary and status of IP rules.

', 'DescribeKeyRegistration' => '

Describes all customer managed key registrations in a Amazon QuickSight account.

', 'DescribeNamespace' => '

Describes the current namespace.

', 'DescribeRefreshSchedule' => '

Provides a summary of a refresh schedule.

', 'DescribeRoleCustomPermission' => '

Describes all custom permissions that are mapped to a role.

', 'DescribeTemplate' => '

Describes a template\'s metadata.

', 'DescribeTemplateAlias' => '

Describes the template alias for a template.

', 'DescribeTemplateDefinition' => '

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

', 'DescribeTemplatePermissions' => '

Describes read and write permissions on a template.

', 'DescribeTheme' => '

Describes a theme.

', 'DescribeThemeAlias' => '

Describes the alias for a theme.

', 'DescribeThemePermissions' => '

Describes the read and write permissions for a theme.

', 'DescribeTopic' => '

Describes a topic.

', 'DescribeTopicPermissions' => '

Describes the permissions of a topic.

', 'DescribeTopicRefresh' => '

Describes the status of a topic refresh.

', 'DescribeTopicRefreshSchedule' => '

Deletes a topic refresh schedule.

', 'DescribeUser' => '

Returns information about a user, given the user name.

', 'DescribeVPCConnection' => '

Describes a VPC connection.

', 'GenerateEmbedUrlForAnonymousUser' => '

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

For more information, see Embedded Analytics 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.

', 'GenerateEmbedUrlForRegisteredUser' => '

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 registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

For more information, see Embedded Analytics 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.

', 'GetDashboardEmbedUrl' => '

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:

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' => '

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:

', 'ListAnalyses' => '

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

', 'ListAssetBundleExportJobs' => '

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

', 'ListAssetBundleImportJobs' => '

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

', 'ListDashboardVersions' => '

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

', 'ListDashboards' => '

Lists dashboards in an Amazon Web Services account.

', 'ListDataSets' => '

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

', 'ListDataSources' => '

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

', 'ListFolderMembers' => '

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

', 'ListFolders' => '

Lists all folders in an account.

', 'ListGroupMemberships' => '

Lists member users in a group.

', 'ListGroups' => '

Lists all user groups in Amazon QuickSight.

', 'ListIAMPolicyAssignments' => '

Lists the IAM policy assignments in the current Amazon QuickSight account.

', 'ListIAMPolicyAssignmentsForUser' => '

Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.

', 'ListIdentityPropagationConfigs' => '

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.

', 'ListIngestions' => '

Lists the history of SPICE ingestions for a dataset.

', 'ListNamespaces' => '

Lists the namespaces for the specified Amazon Web Services account. This operation doesn\'t list deleted namespaces.

', 'ListRefreshSchedules' => '

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

', 'ListRoleMemberships' => '

Lists all groups that are associated with a role.

', 'ListTagsForResource' => '

Lists the tags assigned to a resource.

', 'ListTemplateAliases' => '

Lists all the aliases of a template.

', 'ListTemplateVersions' => '

Lists all the versions of the templates in the current Amazon QuickSight account.

', 'ListTemplates' => '

Lists all the templates in the current Amazon QuickSight account.

', 'ListThemeAliases' => '

Lists all the aliases of a theme.

', 'ListThemeVersions' => '

Lists all the versions of the themes in the current Amazon Web Services account.

', 'ListThemes' => '

Lists all the themes in the current Amazon Web Services account.

', 'ListTopicRefreshSchedules' => '

Lists all of the refresh schedules for a topic.

', 'ListTopicReviewedAnswers' => '

Lists all reviewed answers for a Q Topic.

', 'ListTopics' => '

Lists all of the topics within an account.

', 'ListUserGroups' => '

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

', 'ListUsers' => '

Returns a list of all of the Amazon QuickSight users belonging to this account.

', 'ListVPCConnections' => '

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

', 'PutDataSetRefreshProperties' => '

Creates or updates the dataset refresh properties for the dataset.

', 'RegisterUser' => '

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.

', 'RestoreAnalysis' => '

Restores an analysis.

', 'SearchAnalyses' => '

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'SearchDashboards' => '

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'SearchDataSets' => '

Use the SearchDataSets operation to search for datasets that belong to an account.

', 'SearchDataSources' => '

Use the SearchDataSources operation to search for data sources that belong to an account.

', 'SearchFolders' => '

Searches the subfolders in a folder.

', 'SearchGroups' => '

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

', 'StartAssetBundleExportJob' => '

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.

', 'StartAssetBundleImportJob' => '

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.

', 'StartDashboardSnapshotJob' => '

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.

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.

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:

', 'TagResource' => '

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:

', 'UntagResource' => '

Removes a tag or tags from a resource.

', 'UpdateAccountCustomization' => '

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.

', 'UpdateAccountSettings' => '

Updates the Amazon QuickSight settings in your Amazon Web Services account.

', 'UpdateAnalysis' => '

Updates an analysis in Amazon QuickSight

', 'UpdateAnalysisPermissions' => '

Updates the read and write permissions for an analysis.

', 'UpdateDashboard' => '

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

', 'UpdateDashboardLinks' => '

Updates the linked analyses on a dashboard.

', 'UpdateDashboardPermissions' => '

Updates read and write permissions on a dashboard.

', 'UpdateDashboardPublishedVersion' => '

Updates the published version of a dashboard.

', 'UpdateDataSet' => '

Updates a dataset. This operation doesn\'t support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

', 'UpdateDataSetPermissions' => '

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

', 'UpdateDataSource' => '

Updates a data source.

', 'UpdateDataSourcePermissions' => '

Updates the permissions to a data source.

', 'UpdateFolder' => '

Updates the name of a folder.

', 'UpdateFolderPermissions' => '

Updates permissions of a folder.

', 'UpdateGroup' => '

Changes a group description.

', 'UpdateIAMPolicyAssignment' => '

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

', 'UpdateIdentityPropagationConfig' => '

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

', 'UpdateIpRestriction' => '

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

', 'UpdateKeyRegistration' => '

Updates a customer managed key in a Amazon QuickSight account.

', 'UpdatePublicSharingSettings' => '

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.

', 'UpdateRefreshSchedule' => '

Updates a refresh schedule for a dataset.

', 'UpdateRoleCustomPermission' => '

Updates the custom permissions that are associated with a role.

', 'UpdateSPICECapacityConfiguration' => '

Updates the SPICE capacity configuration for a Amazon QuickSight account.

', 'UpdateTemplate' => '

Updates a template from an existing Amazon QuickSight analysis or another template.

', 'UpdateTemplateAlias' => '

Updates the template alias of a template.

', 'UpdateTemplatePermissions' => '

Updates the resource permissions for a template.

', 'UpdateTheme' => '

Updates a theme.

', 'UpdateThemeAlias' => '

Updates an alias of a theme.

', 'UpdateThemePermissions' => '

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

', 'UpdateTopic' => '

Updates a topic.

', 'UpdateTopicPermissions' => '

Updates the permissions of a topic.

', 'UpdateTopicRefreshSchedule' => '

Updates a topic refresh schedule.

', 'UpdateUser' => '

Updates an Amazon QuickSight user.

', 'UpdateVPCConnection' => '

Updates a VPC connection.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You don\'t have access to this item. The provided credentials couldn\'t be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

', 'refs' => [], ], 'AccountCustomization' => [ 'base' => '

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

', 'refs' => [ 'CreateAccountCustomizationRequest$AccountCustomization' => '

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" }.

', 'CreateAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations you\'re adding in the current Amazon Web Services Region.

', 'DescribeAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

', 'UpdateAccountCustomizationRequest$AccountCustomization' => '

The Amazon QuickSight customizations you\'re updating in the current Amazon Web Services Region.

', 'UpdateAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations you\'re updating in the current Amazon Web Services Region.

', ], ], 'AccountInfo' => [ 'base' => '

A structure that contains the following account information elements:

', 'refs' => [ 'DescribeAccountSubscriptionResponse$AccountInfo' => '

A structure that contains the following elements:

', ], ], 'AccountName' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AccountName' => '

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.

', ], ], 'AccountSettings' => [ 'base' => '

The Amazon QuickSight settings associated with your Amazon Web Services account.

', 'refs' => [ 'DescribeAccountSettingsResponse$AccountSettings' => '

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.

', ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleResourcePermissions$Actions' => '

A list of IAM actions to grant permissions on.

', 'ResourcePermission$Actions' => '

The IAM action to grant or revoke permissions on.

', ], ], 'ActiveIAMPolicyAssignment' => [ 'base' => '

The active Identity and Access Management (IAM) policy assignment.

', 'refs' => [ 'ActiveIAMPolicyAssignmentList$member' => NULL, ], ], 'ActiveIAMPolicyAssignmentList' => [ 'base' => NULL, 'refs' => [ 'ListIAMPolicyAssignmentsForUserResponse$ActiveAssignments' => '

The active assignments for this user.

', ], ], 'AdHocFilteringOption' => [ 'base' => '

An ad hoc (one-time) filtering option.

', 'refs' => [ 'DashboardPublishOptions$AdHocFilteringOption' => '

Ad hoc (one-time) filtering option.

', ], ], 'AdditionalDashboardIdList' => [ 'base' => NULL, 'refs' => [ 'GetDashboardEmbedUrlRequest$AdditionalDashboardIds' => '

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.

', ], ], 'AggFunction' => [ 'base' => '

The definition of an Agg function.

', 'refs' => [ 'TopicIRMetric$Function' => '

The function for the TopicIRMetric.

', ], ], 'AggFunctionParamKey' => [ 'base' => NULL, 'refs' => [ 'AggFunctionParamMap$key' => NULL, ], ], 'AggFunctionParamMap' => [ 'base' => NULL, 'refs' => [ 'AggFunction$AggregationFunctionParameters' => '

The aggregation parameters for an Agg function.

', 'TopicIRFilterOption$AggregationFunctionParameters' => '

The aggregation function parameters for the TopicIRFilterOption.

', ], ], 'AggFunctionParamValue' => [ 'base' => NULL, 'refs' => [ 'AggFunctionParamMap$value' => NULL, ], ], 'AggType' => [ 'base' => NULL, 'refs' => [ 'AggFunction$Aggregation' => '

The aggregation of an Agg function.

', 'FilterAggMetrics$Function' => '

The function for the FilterAggMetrics.

', 'TopicIRFilterOption$Aggregation' => '

The aggregation for the TopicIRFilterOption.

', ], ], 'AggregationFunction' => [ 'base' => '

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AggregationSortConfiguration$AggregationFunction' => '

The function that aggregates the values in Column.

', 'ColumnSort$AggregationFunction' => '

The aggregation function that is defined in the column sort.

', 'ColumnTooltipItem$Aggregation' => '

The aggregation function of the column tooltip item.

', 'NumericEqualityFilter$AggregationFunction' => '

The aggregation function of the filter.

', 'NumericRangeFilter$AggregationFunction' => '

The aggregation function of the filter.

', 'ReferenceLineDynamicDataConfiguration$MeasureAggregationFunction' => '

The aggregation function that is used in the dynamic data.

', ], ], 'AggregationFunctionParameters' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinitionMetric$AggregationFunctionParameters' => '

The additional parameters for an aggregation function.

', ], ], 'AggregationPartitionBy' => [ 'base' => '

The definition of an AggregationPartitionBy.

', 'refs' => [ 'AggregationPartitionByList$member' => NULL, ], ], 'AggregationPartitionByList' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$AggregationPartitionBy' => '

The AggregationPartitionBy for the TopicIRFilterOption.

', ], ], 'AggregationSortConfiguration' => [ 'base' => '

The configuration options to sort aggregated values.

', 'refs' => [ 'AggregationSortConfigurationList$member' => NULL, ], ], 'AggregationSortConfigurationList' => [ 'base' => NULL, 'refs' => [ 'TopBottomFilter$AggregationSortConfigurations' => '

The aggregation and sort configuration of the top bottom filter.

', ], ], 'AliasName' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateAliasRequest$AliasName' => '

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.

', 'CreateThemeAliasRequest$AliasName' => '

The name that you want to give to the theme alias that you are creating. The alias name can\'t begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.

', 'DeleteTemplateAliasRequest$AliasName' => '

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

', 'DeleteTemplateAliasResponse$AliasName' => '

The name for the template alias.

', 'DeleteThemeAliasRequest$AliasName' => '

The unique name for the theme alias to delete.

', 'DeleteThemeAliasResponse$AliasName' => '

The name for the theme alias.

', 'DescribeDashboardDefinitionRequest$AliasName' => '

The alias name.

', 'DescribeDashboardRequest$AliasName' => '

The alias name.

', 'DescribeTemplateAliasRequest$AliasName' => '

The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeTemplateDefinitionRequest$AliasName' => '

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeTemplateRequest$AliasName' => '

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeThemeAliasRequest$AliasName' => '

The name of the theme alias that you want to describe.

', 'DescribeThemeRequest$AliasName' => '

The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to themes.

', 'TemplateAlias$AliasName' => '

The display name of the template alias.

', 'ThemeAlias$AliasName' => '

The display name of the theme alias.

', 'UpdateTemplateAliasRequest$AliasName' => '

The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'UpdateThemeAliasRequest$AliasName' => '

The name of the theme alias that you want to update.

', ], ], 'AllSheetsFilterScopeConfiguration' => [ 'base' => '

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterScopeConfiguration$AllSheets' => '

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

', ], ], 'AmazonElasticsearchParameters' => [ 'base' => '

The parameters for OpenSearch.

', 'refs' => [ 'DataSourceParameters$AmazonElasticsearchParameters' => '

The parameters for OpenSearch.

', ], ], 'AmazonOpenSearchParameters' => [ 'base' => '

The parameters for OpenSearch.

', 'refs' => [ 'DataSourceParameters$AmazonOpenSearchParameters' => '

The parameters for OpenSearch.

', ], ], 'Analysis' => [ 'base' => '

Metadata structure for an analysis in Amazon QuickSight

', 'refs' => [ 'DescribeAnalysisResponse$Analysis' => '

A metadata structure that contains summary information for the analysis that you\'re describing.

', ], ], 'AnalysisDefaults' => [ 'base' => '

The configuration for default analysis settings.

', 'refs' => [ 'AnalysisDefinition$AnalysisDefaults' => NULL, 'DashboardVersionDefinition$AnalysisDefaults' => NULL, 'TemplateVersionDefinition$AnalysisDefaults' => NULL, ], ], 'AnalysisDefinition' => [ 'base' => '

The definition of an analysis.

', 'refs' => [ 'CreateAnalysisRequest$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeAnalysisDefinitionResponse$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateAnalysisRequest$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'AnalysisError' => [ 'base' => '

Analysis error.

', 'refs' => [ 'AnalysisErrorList$member' => NULL, ], ], 'AnalysisErrorList' => [ 'base' => NULL, 'refs' => [ 'Analysis$Errors' => '

Errors associated with the analysis.

', 'DescribeAnalysisDefinitionResponse$Errors' => '

Errors associated with the analysis.

', ], ], 'AnalysisErrorType' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$Type' => '

The type of the analysis error.

', ], ], 'AnalysisFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'AnalysisSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'AnalysisName' => [ 'base' => NULL, 'refs' => [ 'Analysis$Name' => '

The descriptive name of the analysis.

', 'AnalysisSummary$Name' => '

The name of the analysis. This name is displayed in the Amazon QuickSight console.

', 'CreateAnalysisRequest$Name' => '

A descriptive name for the analysis that you\'re creating. This name displays for the analysis in the Amazon QuickSight console.

', 'DescribeAnalysisDefinitionResponse$Name' => '

The descriptive name of the analysis.

', 'UpdateAnalysisRequest$Name' => '

A descriptive name for the analysis that you\'re updating. This name displays for the analysis in the Amazon QuickSight console.

', ], ], 'AnalysisSearchFilter' => [ 'base' => '

A filter that you apply when searching for one or more analyses.

', 'refs' => [ 'AnalysisSearchFilterList$member' => NULL, ], ], 'AnalysisSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchAnalysesRequest$Filters' => '

The structure for the search filters that you want to apply to your search.

', ], ], 'AnalysisSourceEntity' => [ 'base' => '

The source entity of an analysis.

', 'refs' => [ 'CreateAnalysisRequest$SourceEntity' => '

A source entity to use for the analysis that you\'re creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'UpdateAnalysisRequest$SourceEntity' => '

A source entity to use for the analysis that you\'re updating. This metadata structure contains details that describe a source template and one or more datasets.

', ], ], 'AnalysisSourceTemplate' => [ 'base' => '

The source template of an analysis.

', 'refs' => [ 'AnalysisSourceEntity$SourceTemplate' => '

The source template for the source entity of the analysis.

', ], ], 'AnalysisSummary' => [ 'base' => '

The summary metadata that describes an analysis.

', 'refs' => [ 'AnalysisSummaryList$member' => NULL, ], ], 'AnalysisSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAnalysesResponse$AnalysisSummaryList' => '

Metadata describing each of the analyses that are listed.

', 'SearchAnalysesResponse$AnalysisSummaryList' => '

Metadata describing the analyses that you searched for.

', ], ], 'Anchor' => [ 'base' => '

The definition of the Anchor.

', 'refs' => [ 'TopicIRFilterOption$Anchor' => '

The anchor for the TopicIRFilterOption.

', ], ], 'AnchorDateConfiguration' => [ 'base' => '

The date configuration of the filter.

', 'refs' => [ 'RelativeDatesFilter$AnchorDateConfiguration' => '

The date configuration of the filter.

', ], ], 'AnchorOption' => [ 'base' => NULL, 'refs' => [ 'AnchorDateConfiguration$AnchorOption' => '

The options for the date configuration. Choose one of the options below:

', ], ], 'AnchorType' => [ 'base' => NULL, 'refs' => [ 'Anchor$AnchorType' => '

The AnchorType for the Anchor.

', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'base' => '

Information about the dashboard that you want to embed.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$Dashboard' => '

The type of embedding experience. In this case, Amazon QuickSight dashboards.

', ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures$member' => NULL, ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$DisabledFeatures' => '

A list of all disabled features of a specified anonymous dashboard.

', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures$member' => NULL, ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$EnabledFeatures' => '

A list of all enabled features of a specified anonymous dashboard.

', ], ], 'AnonymousUserDashboardFeatureConfigurations' => [ 'base' => '

The feature configuration for an embedded dashboard.

', 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$FeatureConfigurations' => '

The feature configuration for an embedded dashboard.

', ], ], 'AnonymousUserDashboardVisualEmbeddingConfiguration' => [ 'base' => '

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$DashboardVisual' => '

The type of embedding experience. In this case, Amazon QuickSight visuals.

', ], ], 'AnonymousUserEmbeddingExperienceConfiguration' => [ 'base' => '

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

', 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$ExperienceConfiguration' => '

The configuration of the experience that you are embedding.

', ], ], 'AnonymousUserGenerativeQnAEmbeddingConfiguration' => [ 'base' => '

The settings that you want to use for the Generative Q&A experience.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$GenerativeQnA' => '

The Generative Q&A experience that you want to use for anonymous user embedding.

', ], ], 'AnonymousUserQSearchBarEmbeddingConfiguration' => [ 'base' => '

The settings that you want to use with the Q search bar.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$QSearchBar' => '

The Q search bar that you want to use for anonymous user embedding.

', ], ], 'AnonymousUserSnapshotJobResult' => [ 'base' => '

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.

', 'refs' => [ 'AnonymousUserSnapshotJobResultList$member' => NULL, ], ], 'AnonymousUserSnapshotJobResultList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobResult$AnonymousUsers' => '

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

', ], ], 'AnswerId' => [ 'base' => NULL, 'refs' => [ 'AnswerIds$member' => NULL, 'CreateTopicReviewedAnswer$AnswerId' => '

The answer ID for the CreateTopicReviewedAnswer.

', 'InvalidTopicReviewedAnswer$AnswerId' => '

The answer ID for the InvalidTopicReviewedAnswer.

', 'SucceededTopicReviewedAnswer$AnswerId' => '

The answer ID for the SucceededTopicReviewedAnswer.

', 'TopicReviewedAnswer$AnswerId' => '

The answer ID of the reviewed answer.

', ], ], 'AnswerIds' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTopicReviewedAnswerRequest$AnswerIds' => '

The Answer IDs of the Answers to be deleted.

', ], ], 'ArcAxisConfiguration' => [ 'base' => '

The arc axis configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartOptions$ArcAxis' => '

The arc axis configuration of a GaugeChartVisual.

', ], ], 'ArcAxisDisplayRange' => [ 'base' => '

The arc axis range of a GaugeChartVisual.

', 'refs' => [ 'ArcAxisConfiguration$Range' => '

The arc axis range of a GaugeChartVisual.

', ], ], 'ArcConfiguration' => [ 'base' => '

The arc configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartOptions$Arc' => '

The arc configuration of a GaugeChartVisual.

', ], ], 'ArcOptions' => [ 'base' => '

The options that determine the arc thickness of a GaugeChartVisual.

', 'refs' => [ 'DonutOptions$ArcOptions' => '

The option for define the arc of the chart shape. Valid values are as follows:

', ], ], 'ArcThickness' => [ 'base' => NULL, 'refs' => [ 'ArcOptions$ArcThickness' => '

The arc thickness of a GaugeChartVisual.

', ], ], 'ArcThicknessOptions' => [ 'base' => NULL, 'refs' => [ 'ArcConfiguration$ArcThickness' => '

The options that determine the arc thickness of a GaugeChartVisual.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AccountCustomization$DefaultTheme' => '

The default theme for this Amazon QuickSight subscription.

', 'AccountCustomization$DefaultEmailCustomizationTemplate' => '

The default email customization template.

', 'ActiveIAMPolicyAssignment$PolicyArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'Analysis$Arn' => '

The Amazon Resource Name (ARN) of the analysis.

', 'Analysis$ThemeArn' => '

The ARN of the theme of the analysis.

', 'AnalysisSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the source template of an analysis.

', 'AnalysisSummary$Arn' => '

The Amazon Resource Name (ARN) for the analysis.

', 'ArnList$member' => NULL, 'AssetBundleExportJobAnalysisOverrideProperties$Arn' => '

The ARN of the specific Analysis resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDashboardOverrideProperties$Arn' => '

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDataSetOverrideProperties$Arn' => '

The ARN of the specific DataSet resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDataSourceOverrideProperties$Arn' => '

The ARN of the specific DataSource resource whose override properties are configured in this structure.

', 'AssetBundleExportJobError$Arn' => '

The ARN of the resource whose processing caused an error.

', 'AssetBundleExportJobRefreshScheduleOverrideProperties$Arn' => '

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

', 'AssetBundleExportJobSummary$Arn' => '

The ARN of the export job.

', 'AssetBundleExportJobThemeOverrideProperties$Arn' => '

The ARN of the specific Theme resource whose override properties are configured in this structure.

', 'AssetBundleExportJobVPCConnectionOverrideProperties$Arn' => '

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

', 'AssetBundleExportJobWarning$Arn' => '

The ARN of the resource whose processing caused a warning.

', 'AssetBundleImportJobError$Arn' => '

The ARN of the resource whose processing caused an error.

', 'AssetBundleImportJobSummary$Arn' => '

The ARN of the import job.

', 'AssetBundleImportJobWarning$Arn' => '

The ARN of the resource that the warning occurred for.

', 'AssetBundleResourceArns$member' => NULL, 'BatchCreateTopicReviewedAnswerResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'BatchDeleteTopicReviewedAnswerResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CancelIngestionResponse$Arn' => '

The Amazon Resource Name (ARN) for the data ingestion.

', 'CreateAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

', 'CreateAnalysisRequest$ThemeArn' => '

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.

', 'CreateAnalysisResponse$Arn' => '

The ARN for the analysis.

', 'CreateDashboardRequest$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

', 'CreateDashboardResponse$Arn' => '

The ARN of the dashboard.

', 'CreateDashboardResponse$VersionArn' => '

The ARN of the dashboard, including the version number of the first version that is created.

', 'CreateDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateDataSetResponse$IngestionArn' => '

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'CreateDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'CreateFolderRequest$ParentFolderArn' => '

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

', 'CreateFolderResponse$Arn' => '

The Amazon Resource Name (ARN) for the newly created folder.

', 'CreateIAMPolicyAssignmentRequest$PolicyArn' => '

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

', 'CreateIAMPolicyAssignmentResponse$PolicyArn' => '

The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.

', 'CreateIngestionResponse$Arn' => '

The Amazon Resource Name (ARN) for the data ingestion.

', 'CreateNamespaceResponse$Arn' => '

The ARN of the Amazon QuickSight namespace you created.

', 'CreateRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'CreateTemplateResponse$Arn' => '

The ARN for the template.

', 'CreateTemplateResponse$VersionArn' => '

The ARN for the template, including the version information of the first version.

', 'CreateThemeResponse$Arn' => '

The Amazon Resource Name (ARN) for the theme.

', 'CreateThemeResponse$VersionArn' => '

The Amazon Resource Name (ARN) for the new theme.

', 'CreateTopicRefreshScheduleRequest$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CreateTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CreateTopicResponse$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'CreateTopicReviewedAnswer$DatasetArn' => '

The Dataset arn for the CreateTopicReviewedAnswer.

', 'CreateVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'CustomSql$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'Dashboard$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersion$SourceEntityArn' => '

Source entity ARN.

', 'DashboardVersion$ThemeArn' => '

The ARN of the theme associated with a version of the dashboard.

', 'DashboardVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersionSummary$SourceEntityArn' => '

Source entity ARN.

', 'DataSet$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DataSetArnsList$member' => NULL, 'DataSetIdentifierDeclaration$DataSetArn' => '

The Amazon Resource Name (ARN) of the data set.

', 'DataSetReference$DataSetArn' => '

Dataset Amazon Resource Name (ARN).

', 'DataSetSummary$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DataSource$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'DataSourceSummary$Arn' => '

The arn of the datasource.

', 'DatasetMetadata$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteAnalysisResponse$Arn' => '

The Amazon Resource Name (ARN) of the deleted analysis.

', 'DeleteDashboardResponse$Arn' => '

The Secure Socket Layer (SSL) properties that apply for the resource.

', 'DeleteDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source that you deleted.

', 'DeleteFolderResponse$Arn' => '

The Amazon Resource Name of the deleted folder.

', 'DeleteRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'DeleteTemplateAliasResponse$Arn' => '

The Amazon Resource Name (ARN) of the template you want to delete.

', 'DeleteTemplateResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DeleteThemeAliasResponse$Arn' => '

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

', 'DeleteThemeResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DeleteTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DeleteTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DeleteVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the deleted VPC connection.

', 'DescribeAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) of the customization that\'s associated with this Amazon Web Services account.

', 'DescribeAnalysisDefinitionResponse$ThemeArn' => '

The ARN of the theme of the analysis.

', 'DescribeAnalysisPermissionsResponse$AnalysisArn' => '

The Amazon Resource Name (ARN) of the analysis whose permissions you\'re describing.

', 'DescribeAssetBundleExportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the export job.

', 'DescribeAssetBundleImportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the import job.

', 'DescribeDashboardDefinitionResponse$ThemeArn' => '

The ARN of the theme of the dashboard.

', 'DescribeDashboardPermissionsResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'DescribeDashboardSnapshotJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResultResponse$Arn' => '

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDataSetPermissionsResponse$DataSetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DescribeDataSourcePermissionsResponse$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'DescribeFolderPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) for the folder.

', 'DescribeFolderResolvedPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'DescribeRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'DescribeTemplateDefinitionResponse$ThemeArn' => '

The ARN of the theme of the template.

', 'DescribeTemplatePermissionsResponse$TemplateArn' => '

The Amazon Resource Name (ARN) of the template.

', 'DescribeThemePermissionsResponse$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme.

', 'DescribeTopicPermissionsResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DescribeTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DescribeTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DescribeTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'Folder$Arn' => '

The Amazon Resource Name (ARN) for the folder.

', 'FolderArnList$member' => NULL, 'FolderSummary$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'GenerateEmbedUrlForAnonymousUserResponse$AnonymousUserArn' => '

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

', 'GenerateEmbedUrlForRegisteredUserRequest$UserArn' => '

The Amazon Resource Name for the registered user.

', 'GetDashboardEmbedUrlRequest$UserArn' => '

The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

', 'GetSessionEmbedUrlRequest$UserArn' => '

The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

  1. Active Directory (AD) users or group members

  2. Invited nonfederated users

  3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

', 'Group$Arn' => '

The Amazon Resource Name (ARN) for the group.

', 'GroupMember$Arn' => '

The Amazon Resource Name (ARN) for the group member (user).

', 'IAMPolicyAssignment$PolicyArn' => '

The Amazon Resource Name (ARN) for the IAM policy.

', 'Ingestion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

', 'ListTopicRefreshSchedulesResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'ListTopicReviewedAnswersResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'LogicalTableSource$DataSetArn' => '

The Amazon Resource Number (ARN) of the parent dataset.

', 'MemberIdArnPair$MemberArn' => '

The Amazon Resource Name (ARN) of the member.

', 'NamespaceInfoV2$Arn' => '

The namespace ARN.

', 'Path$member' => NULL, 'RefreshSchedule$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'RelationalTable$DataSourceArn' => '

The Amazon Resource Name (ARN) for the data source.

', 'RestoreAnalysisResponse$Arn' => '

The Amazon Resource Name (ARN) of the analysis that you\'re restoring.

', 'RowLevelPermissionDataSet$Arn' => '

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

', 'S3Source$DataSourceArn' => '

The Amazon Resource Name (ARN) for the data source.

', 'StartAssetBundleExportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the export job.

', 'StartAssetBundleImportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the import job.

', 'StartDashboardSnapshotJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the dashboard snapshot job.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'Template$Arn' => '

The Amazon Resource Name (ARN) of the template.

', 'TemplateAlias$Arn' => '

The Amazon Resource Name (ARN) of the template alias.

', 'TemplateSourceAnalysis$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TemplateSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TemplateSummary$Arn' => '

A summary of a template.

', 'TemplateVersion$SourceEntityArn' => '

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

', 'TemplateVersion$ThemeArn' => '

The ARN of the theme associated with this version of the template.

', 'TemplateVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the template version.

', 'Theme$Arn' => '

The Amazon Resource Name (ARN) of the theme.

', 'ThemeAlias$Arn' => '

The Amazon Resource Name (ARN) of the theme alias.

', 'ThemeSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ThemeVersion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ThemeVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the theme version.

', 'TopicRefreshDetails$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'TopicRefreshScheduleSummary$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'TopicReviewedAnswer$Arn' => '

The Amazon Resource Name (ARN) of the reviewed answer.

', 'TopicReviewedAnswer$DatasetArn' => '

The Dataset ARN for the TopicReviewedAnswer.

', 'TopicSummary$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to untag.

', 'UpdateAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

', 'UpdateAnalysisPermissionsResponse$AnalysisArn' => '

The Amazon Resource Name (ARN) of the analysis that you updated.

', 'UpdateAnalysisRequest$ThemeArn' => '

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.

', 'UpdateAnalysisResponse$Arn' => '

The ARN of the analysis that you\'re updating.

', 'UpdateDashboardLinksResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardPermissionsResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardPublishedVersionResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardRequest$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

', 'UpdateDashboardResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UpdateDashboardResponse$VersionArn' => '

The ARN of the dashboard, including the version number.

', 'UpdateDataSetPermissionsResponse$DataSetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateDataSetResponse$IngestionArn' => '

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'UpdateDataSourcePermissionsResponse$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'UpdateDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'UpdateFolderPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'UpdateFolderResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'UpdateIAMPolicyAssignmentRequest$PolicyArn' => '

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

', 'UpdateIAMPolicyAssignmentResponse$PolicyArn' => '

The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

', 'UpdateRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'UpdateTemplatePermissionsResponse$TemplateArn' => '

The Amazon Resource Name (ARN) of the template.

', 'UpdateTemplateResponse$Arn' => '

The Amazon Resource Name (ARN) for the template.

', 'UpdateTemplateResponse$VersionArn' => '

The ARN for the template, including the version information of the first version.

', 'UpdateThemePermissionsResponse$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme.

', 'UpdateThemeResponse$Arn' => '

The Amazon Resource Name (ARN) for the theme.

', 'UpdateThemeResponse$VersionArn' => '

The Amazon Resource Name (ARN) for the new version of the theme.

', 'UpdateTopicPermissionsResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicResponse$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'UpdateVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'User$Arn' => '

The Amazon Resource Name (ARN) for the user.

', 'VPCConnection$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'VPCConnectionSummary$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'VpcConnectionProperties$VpcConnectionArn' => '

The Amazon Resource Name (ARN) for the VPC connection.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$AuthorizedResourceArns' => '

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.

', ], ], 'AssetBundleCloudFormationOverridePropertyConfiguration' => [ 'base' => '

An optional collection of CloudFormation property configurations that control how the export job is generated.

', 'refs' => [ 'DescribeAssetBundleExportJobResponse$CloudFormationOverridePropertyConfiguration' => '

The CloudFormation override property configuration for the export job.

', 'StartAssetBundleExportJobRequest$CloudFormationOverridePropertyConfiguration' => '

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

', ], ], 'AssetBundleExportFormat' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobSummary$ExportFormat' => '

The format for the export job.

', 'DescribeAssetBundleExportJobResponse$ExportFormat' => '

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

', 'StartAssetBundleExportJobRequest$ExportFormat' => '

The export data format.

', ], ], 'AssetBundleExportJobAnalysisOverrideProperties' => [ 'base' => '

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobAnalysisOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobAnalysisOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Analyses' => '

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobAnalysisPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobAnalysisPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobAnalysisPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobAnalysisOverrideProperties$Properties' => '

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDashboardOverrideProperties' => [ 'base' => '

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDashboardOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDashboardOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Dashboards' => '

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDashboardPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDashboardPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDashboardPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDashboardOverrideProperties$Properties' => '

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSetOverrideProperties' => [ 'base' => '

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDataSetOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDataSetOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$DataSets' => '

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSetPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSetPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDataSetPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSetOverrideProperties$Properties' => '

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSourceOverrideProperties' => [ 'base' => '

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDataSourceOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDataSourceOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$DataSources' => '

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSourcePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSourcePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDataSourcePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSourceOverrideProperties$Properties' => '

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobError' => [ 'base' => '

Describes an error that occurred during an Asset Bundle export job.

', 'refs' => [ 'AssetBundleExportJobErrorList$member' => NULL, ], ], 'AssetBundleExportJobErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$Errors' => '

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

', ], ], 'AssetBundleExportJobRefreshScheduleOverrideProperties' => [ 'base' => '

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobRefreshScheduleOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobRefreshScheduleOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$RefreshSchedules' => '

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobRefreshScheduleOverrideProperties$Properties' => '

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobResourceIdOverrideConfiguration' => [ 'base' => '

An optional structure that configures resource ID overrides for the export job.

', 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$ResourceIdOverrideConfiguration' => '

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobSummary$JobStatus' => '

The current status of the export job.

', 'DescribeAssetBundleExportJobResponse$JobStatus' => '

Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

', ], ], 'AssetBundleExportJobSummary' => [ 'base' => '

A summary of the export job that includes details of the job\'s configuration and its current status.

', 'refs' => [ 'AssetBundleExportJobSummaryList$member' => NULL, ], ], 'AssetBundleExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAssetBundleExportJobsResponse$AssetBundleExportJobSummaryList' => '

A list of export job summaries.

', ], ], 'AssetBundleExportJobThemeOverrideProperties' => [ 'base' => '

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobThemeOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobThemeOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Themes' => '

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobThemePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobThemePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobThemePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobThemeOverrideProperties$Properties' => '

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobVPCConnectionOverrideProperties' => [ 'base' => '

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobVPCConnectionOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobVPCConnectionOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$VPCConnections' => '

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobVPCConnectionPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobVPCConnectionOverrideProperties$Properties' => '

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobValidationStrategy' => [ 'base' => '

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

', 'refs' => [ 'DescribeAssetBundleExportJobResponse$ValidationStrategy' => '

The validation strategy that is used to export the analysis or dashboard.

', 'StartAssetBundleExportJobRequest$ValidationStrategy' => '

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

', ], ], 'AssetBundleExportJobWarning' => [ 'base' => '

Describes a warning that occurred during an Asset Bundle export job.

', 'refs' => [ 'AssetBundleExportJobWarningList$member' => NULL, ], ], 'AssetBundleExportJobWarningList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$Warnings' => '

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

', ], ], 'AssetBundleImportBodyBlob' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSource$Body' => '

The bytes of the base64 encoded asset bundle import zip file. This file can\'t exceed 20 MB.

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file\'s bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.

', ], ], 'AssetBundleImportFailureAction' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobSummary$FailureAction' => '

The failure action for the import job.

', 'DescribeAssetBundleImportJobResponse$FailureAction' => '

The failure action for the import job.

', 'StartAssetBundleImportJobRequest$FailureAction' => '

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.

', ], ], 'AssetBundleImportJobAnalysisOverrideParameters' => [ 'base' => '

The override parameters for a single analysis that is being imported.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Analyses' => '

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobAnalysisOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of analysis IDs.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Analyses' => '

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobAnalysisOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of analysis IDs.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Analyses' => '

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverrideParameters' => [ 'base' => '

The override parameters for a single dashboard that is being imported.

', 'refs' => [ 'AssetBundleImportJobDashboardOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Dashboards' => '

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of dashboard IDs.

', 'refs' => [ 'AssetBundleImportJobDashboardOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Dashboards' => '

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of dashboard IDs.

', 'refs' => [ 'AssetBundleImportJobDashboardOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Dashboards' => '

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverrideParameters' => [ 'base' => '

The override parameters for a single dataset that is being imported.

', 'refs' => [ 'AssetBundleImportJobDataSetOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$DataSets' => '

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of dataset IDs.

', 'refs' => [ 'AssetBundleImportJobDataSetOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$DataSets' => '

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of dataset IDs.

', 'refs' => [ 'AssetBundleImportJobDataSetOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$DataSets' => '

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceCredentialPair' => [ 'base' => '

A username and password credential pair to use to import a data source resource.

', 'refs' => [ 'AssetBundleImportJobDataSourceCredentials$CredentialPair' => '

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

', ], ], 'AssetBundleImportJobDataSourceCredentials' => [ 'base' => '

The login credentials to use to import a data source resource.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$Credentials' => '

An optional structure that provides the credentials to be used to create the imported data source.

', ], ], 'AssetBundleImportJobDataSourceOverrideParameters' => [ 'base' => '

The override parameters for a single data source that is being imported.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$DataSources' => '

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of data source IDs.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$DataSources' => '

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of data source IDs.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$DataSources' => '

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobError' => [ 'base' => '

Describes an error that occurred within an Asset Bundle import execution.

', 'refs' => [ 'AssetBundleImportJobErrorList$member' => NULL, ], ], 'AssetBundleImportJobErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleImportJobResponse$Errors' => '

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

', 'DescribeAssetBundleImportJobResponse$RollbackErrors' => '

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

', ], ], 'AssetBundleImportJobOverrideParameters' => [ 'base' => '

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideParameters' => '

Optional overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideParameters' => '

Optional overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverridePermissions' => [ 'base' => '

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverridePermissions' => '

Optional permission overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverridePermissions' => '

Optional permission overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverrideTags' => [ 'base' => '

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideTags' => '

Optional tag overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideTags' => '

Optional tag overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverrideValidationStrategy' => [ 'base' => '

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideValidationStrategy' => '

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideValidationStrategy' => '

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobRefreshScheduleOverrideParameters' => [ 'base' => '

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

', 'refs' => [ 'AssetBundleImportJobRefreshScheduleOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobRefreshScheduleOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$RefreshSchedules' => '

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobResourceIdOverrideConfiguration' => [ 'base' => '

An optional structure that configures resource ID overrides for the import job.

', 'refs' => [ 'AssetBundleImportJobOverrideParameters$ResourceIdOverrideConfiguration' => '

An optional structure that configures resource ID overrides to be applied within the import job.

', ], ], 'AssetBundleImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobSummary$JobStatus' => '

The current status of the import job.

', 'DescribeAssetBundleImportJobResponse$JobStatus' => '

Indicates the status of a job through its queuing and execution.

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

', ], ], 'AssetBundleImportJobSummary' => [ 'base' => '

A summary of the import job that includes details of the requested job\'s configuration and its current status.

', 'refs' => [ 'AssetBundleImportJobSummaryList$member' => NULL, ], ], 'AssetBundleImportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAssetBundleImportJobsResponse$AssetBundleImportJobSummaryList' => '

A list of import job summaries.

', ], ], 'AssetBundleImportJobThemeOverrideParameters' => [ 'base' => '

The override parameters for a single theme that is imported.

', 'refs' => [ 'AssetBundleImportJobThemeOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Themes' => '

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobThemeOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of theme IDs.

', 'refs' => [ 'AssetBundleImportJobThemeOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Themes' => '

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobThemeOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of theme IDs.

', 'refs' => [ 'AssetBundleImportJobThemeOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Themes' => '

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobVPCConnectionOverrideParameters' => [ 'base' => '

The override parameters for a single VPC connection that is imported.

', 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobVPCConnectionOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$VPCConnections' => '

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobVPCConnectionOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

', 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobVPCConnectionOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$VPCConnections' => '

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobWarning' => [ 'base' => '

Describes a warning that occurred during an Asset Bundle import job.

', 'refs' => [ 'AssetBundleImportJobWarningList$member' => NULL, ], ], 'AssetBundleImportJobWarningList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleImportJobResponse$Warnings' => '

An array of warning records that describe all permitted errors that are encountered during the import job.

', ], ], 'AssetBundleImportSource' => [ 'base' => '

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

', 'refs' => [ 'StartAssetBundleImportJobRequest$AssetBundleImportSource' => '

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

', ], ], 'AssetBundleImportSourceDescription' => [ 'base' => '

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$AssetBundleImportSource' => '

The source of the asset bundle zip file that contains the data that is imported by the job.

', ], ], 'AssetBundlePrincipalList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleResourcePermissions$Principals' => '

A list of principals to grant permissions on.

', ], ], 'AssetBundleResourceArns' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$ResourceArns' => '

A list of resource ARNs that exported with the job.

', 'StartAssetBundleExportJobRequest$ResourceArns' => '

An array of resource ARNs to export. The following resources are supported.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

', ], ], 'AssetBundleResourceLinkSharingConfiguration' => [ 'base' => '

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

', 'refs' => [ 'AssetBundleImportJobDashboardOverridePermissions$LinkSharingConfiguration' => '

A structure that contains the link sharing configurations that you want to apply overrides to.

', ], ], 'AssetBundleResourcePermissions' => [ 'base' => '

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissions$Permissions' => '

A list of permissions for the analyses that you want to apply overrides to.

', 'AssetBundleImportJobDashboardOverridePermissions$Permissions' => '

A list of permissions for the dashboards that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverridePermissions$Permissions' => '

A list of permissions for the datasets that you want to apply overrides to.

', 'AssetBundleImportJobDataSourceOverridePermissions$Permissions' => '

A list of permissions for the data source that you want to apply overrides to.

', 'AssetBundleImportJobThemeOverridePermissions$Permissions' => '

A list of permissions for the themes that you want to apply overrides to.

', 'AssetBundleResourceLinkSharingConfiguration$Permissions' => '

A list of link sharing permissions for the dashboards that you want to apply overrides to.

', ], ], 'AssetBundleRestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AssetBundleRestrictiveResourceIdList$member' => NULL, ], ], 'AssetBundleRestrictiveResourceIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissions$AnalysisIds' => '

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

', 'AssetBundleImportJobAnalysisOverrideTags$AnalysisIds' => '

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

', 'AssetBundleImportJobDashboardOverridePermissions$DashboardIds' => '

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

', 'AssetBundleImportJobDashboardOverrideTags$DashboardIds' => '

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

', 'AssetBundleImportJobDataSetOverridePermissions$DataSetIds' => '

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

', 'AssetBundleImportJobDataSetOverrideTags$DataSetIds' => '

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

', 'AssetBundleImportJobDataSourceOverridePermissions$DataSourceIds' => '

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

', 'AssetBundleImportJobDataSourceOverrideTags$DataSourceIds' => '

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

', 'AssetBundleImportJobThemeOverridePermissions$ThemeIds' => '

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

', 'AssetBundleImportJobThemeOverrideTags$ThemeIds' => '

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

', 'AssetBundleImportJobVPCConnectionOverrideTags$VPCConnectionIds' => '

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

', ], ], 'AssetOptions' => [ 'base' => '

An array of analysis level configurations.

', 'refs' => [ 'AnalysisDefinition$Options' => '

An array of option definitions for an analysis.

', 'DashboardVersionDefinition$Options' => '

An array of option definitions for a dashboard.

', 'TemplateVersionDefinition$Options' => '

An array of option definitions for a template.

', ], ], 'AssignmentStatus' => [ 'base' => NULL, 'refs' => [ 'CreateIAMPolicyAssignmentRequest$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'CreateIAMPolicyAssignmentResponse$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'IAMPolicyAssignment$AssignmentStatus' => '

Assignment status.

', 'IAMPolicyAssignmentSummary$AssignmentStatus' => '

Assignment status.

', 'ListIAMPolicyAssignmentsRequest$AssignmentStatus' => '

The status of the assignments.

', 'UpdateIAMPolicyAssignmentRequest$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'UpdateIAMPolicyAssignmentResponse$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', ], ], 'AthenaParameters' => [ 'base' => '

Parameters for Amazon Athena.

', 'refs' => [ 'DataSourceParameters$AthenaParameters' => '

The parameters for Amazon Athena.

', ], ], 'AttributeAggregationFunction' => [ 'base' => '

Aggregation for attributes.

', 'refs' => [ 'AggregationFunction$AttributeAggregationFunction' => '

Aggregation for attributes.

', ], ], 'AuroraParameters' => [ 'base' => '

Parameters for Amazon Aurora.

', 'refs' => [ 'DataSourceParameters$AuroraParameters' => '

The parameters for Amazon Aurora MySQL.

', ], ], 'AuroraPostgreSqlParameters' => [ 'base' => '

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

', 'refs' => [ 'DataSourceParameters$AuroraPostgreSqlParameters' => '

The parameters for Amazon Aurora.

', ], ], 'AuthenticationMethodOption' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AuthenticationMethod' => '

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.

', ], ], 'AuthorSpecifiedAggregation' => [ 'base' => NULL, 'refs' => [ 'AuthorSpecifiedAggregations$member' => NULL, ], ], 'AuthorSpecifiedAggregations' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$AllowedAggregations' => '

The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicCalculatedField$NotAllowedAggregations' => '

The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicColumn$AllowedAggregations' => '

The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicColumn$NotAllowedAggregations' => '

The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', ], ], 'AuthorizedTargetsByService' => [ 'base' => '

The authorized targets that are associated with a service.

', 'refs' => [ 'AuthorizedTargetsByServices$member' => NULL, ], ], 'AuthorizedTargetsByServices' => [ 'base' => NULL, 'refs' => [ 'ListIdentityPropagationConfigsResponse$Services' => '

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

', ], ], 'AuthorizedTargetsList' => [ 'base' => NULL, 'refs' => [ 'AuthorizedTargetsByService$AuthorizedTargets' => '

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

', 'UpdateIdentityPropagationConfigRequest$AuthorizedTargets' => '

Specifies a list of application ARNs that represent the authorized targets for a service.

', ], ], 'AwsAccountId' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

', 'BatchDeleteTopicReviewedAnswerRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

', 'CancelIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

', 'CreateAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

', 'CreateAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that you\'re using to create your Amazon QuickSight account.

', 'CreateAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you are creating an analysis.

', 'CreateDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to create the dashboard.

', 'CreateDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateFolderMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'CreateFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account where you want to create the folder.

', 'CreateGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

', 'CreateIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

', 'CreateRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateRoleMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

', 'CreateTemplateRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

', 'CreateThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to store the new theme.

', 'CreateTopicRefreshScheduleRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic you\'re creating a refresh schedule for.

', 'CreateTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to create a topic in.

', 'CreateVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account where you want to create a new VPC connection.

', 'DeleteAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

', 'DeleteAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that you want to delete.

', 'DeleteAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to delete an analysis.

', 'DeleteDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re deleting.

', 'DeleteDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteFolderMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DeleteFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DeleteGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteIAMPolicyAssignmentRequest$AwsAccountId' => '

The Amazon Web Services account ID where you want to delete the IAM policy assignment.

', 'DeleteIdentityPropagationConfigRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

', 'DeleteNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

', 'DeleteRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteRoleMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the item to delete.

', 'DeleteTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re deleting.

', 'DeleteThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias to delete.

', 'DeleteThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re deleting.

', 'DeleteTopicRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to delete.

', 'DeleteUserByPrincipalIdRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account where you want to delete a VPC connection.

', 'DescribeAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

', 'DescribeAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you\'re describing.

', 'DescribeAccountSettingsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the settings that you want to list.

', 'DescribeAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID associated with your Amazon QuickSight account.

', 'DescribeAnalysisDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAnalysisPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis whose permissions you\'re describing. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAssetBundleExportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account the export job is executed in.

', 'DescribeAssetBundleExportJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that the export job was executed in.

', 'DescribeAssetBundleImportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account the import job was executed in.

', 'DescribeAssetBundleImportJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account the import job was executed in.

', 'DescribeDashboardDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing.

', 'DescribeDashboardPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing permissions for.

', 'DescribeDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing.

', 'DescribeDashboardSnapshotJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDashboardSnapshotJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDashboardSnapshotJobResultRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDataSetPermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSourcePermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeFolderPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeFolderResolvedPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the assignment that you want to describe.

', 'DescribeIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeIpRestrictionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'DescribeIpRestrictionResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'DescribeKeyRegistrationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

', 'DescribeKeyRegistrationResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

', 'DescribeNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

', 'DescribeRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template alias that you\'re describing.

', 'DescribeTemplateDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

', 'DescribeTemplatePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re describing.

', 'DescribeTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re describing.

', 'DescribeThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias that you\'re describing.

', 'DescribeThemePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re describing.

', 'DescribeTopicPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want described.

', 'DescribeTopicRefreshRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

', 'DescribeTopicRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeTopicRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connection that you want described.

', 'GenerateEmbedUrlForAnonymousUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GenerateEmbedUrlForRegisteredUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GetDashboardEmbedUrlRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GetSessionEmbedUrlRequest$AwsAccountId' => '

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

', 'IAMPolicyAssignment$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListAnalysesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analyses.

', 'ListAssetBundleExportJobsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the export jobs were executed in.

', 'ListAssetBundleImportJobsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the import jobs were executed in.

', 'ListDashboardVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re listing versions for.

', 'ListDashboardsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboards that you\'re listing.

', 'ListDataSetsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListDataSourcesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListFolderMembersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'ListFoldersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'ListGroupMembershipsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListGroupsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListIAMPolicyAssignmentsForUserRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the assignments.

', 'ListIAMPolicyAssignmentsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains these IAM policy assignments.

', 'ListIdentityPropagationConfigsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

', 'ListIngestionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListNamespacesRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

', 'ListRefreshSchedulesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListRoleMembershipsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListTemplateAliasesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template aliases that you\'re listing.

', 'ListTemplateVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the templates that you\'re listing.

', 'ListTemplatesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the templates that you\'re listing.

', 'ListThemeAliasesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme aliases that you\'re listing.

', 'ListThemeVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the themes that you\'re listing.

', 'ListThemesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the themes that you\'re listing.

', 'ListTopicRefreshSchedulesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.

', 'ListTopicReviewedAnswersRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

', 'ListTopicsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topics that you want to list.

', 'ListUserGroupsRequest$AwsAccountId' => '

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListUsersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListVPCConnectionsRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.

', 'PutDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'RegisterUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'RestoreAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis.

', 'SearchAnalysesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analyses that you\'re searching for.

', 'SearchDashboardsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the user whose dashboards you\'re searching for.

', 'SearchDataSetsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'SearchDataSourcesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'SearchFoldersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'SearchGroupsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'StartAssetBundleExportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account to export assets from.

', 'StartAssetBundleImportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account to import assets into.

', 'StartDashboardSnapshotJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'UpdateAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountSettingsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

', 'UpdateAnalysisPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis whose permissions you\'re updating. You must be using the Amazon Web Services account that the analysis is in.

', 'UpdateAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis that you\'re updating.

', 'UpdateDashboardLinksRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

', 'UpdateDashboardPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard whose permissions you\'re updating.

', 'UpdateDashboardPublishedVersionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re updating.

', 'UpdateDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re updating.

', 'UpdateDataSetPermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSourcePermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateFolderPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder to update.

', 'UpdateFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder to update.

', 'UpdateGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IAM policy assignment.

', 'UpdateIdentityPropagationConfigRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

', 'UpdateIpRestrictionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'UpdateIpRestrictionResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'UpdateKeyRegistrationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

', 'UpdatePublicSharingSettingsRequest$AwsAccountId' => '

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

', 'UpdateRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateSPICECapacityConfigurationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

', 'UpdateTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template alias that you\'re updating.

', 'UpdateTemplatePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template.

', 'UpdateTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re updating.

', 'UpdateThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias that you\'re updating.

', 'UpdateThemePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme.

', 'UpdateThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re updating.

', 'UpdateTopicPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.

', 'UpdateTopicRefreshScheduleRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.

', 'UpdateTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to update.

', 'UpdateUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.

', ], ], 'AwsAndAccountId' => [ 'base' => NULL, 'refs' => [ 'DescribeThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re describing.

', ], ], 'AwsIotAnalyticsParameters' => [ 'base' => '

The parameters for IoT Analytics.

', 'refs' => [ 'DataSourceParameters$AwsIotAnalyticsParameters' => '

The parameters for IoT Analytics.

', ], ], 'AxisBinding' => [ 'base' => NULL, 'refs' => [ 'DataFieldSeriesItem$AxisBinding' => '

The axis that you are binding the field to.

', 'FieldSeriesItem$AxisBinding' => '

The axis that you are binding the field to.

', 'LineChartDefaultSeriesSettings$AxisBinding' => '

The axis to which you are binding all line series to.

', 'ReferenceLineDataConfiguration$AxisBinding' => '

The axis binding type of the reference line. Choose one of the following options:

', ], ], 'AxisDataOptions' => [ 'base' => '

The data options for an axis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AxisDisplayOptions$DataOptions' => '

The data options for an axis.

', ], ], 'AxisDisplayDataDrivenRange' => [ 'base' => '

The options that are saved for future extension.

', 'refs' => [ 'AxisDisplayRange$DataDriven' => '

The data-driven setup of an axis display range.

', ], ], 'AxisDisplayMinMaxRange' => [ 'base' => '

The minimum and maximum setup for an axis display range.

', 'refs' => [ 'AxisDisplayRange$MinMax' => '

The minimum and maximum setup of an axis display range.

', ], ], 'AxisDisplayOptions' => [ 'base' => '

The display options for the axis label.

', 'refs' => [ 'BarChartConfiguration$CategoryAxis' => '

The label display options (grid line, range, scale, axis step) for bar chart category.

', 'BarChartConfiguration$ValueAxis' => '

The label display options (grid line, range, scale, axis step) for a bar chart value.

', 'BoxPlotChartConfiguration$CategoryAxis' => '

The label display options (grid line, range, scale, axis step) of a box plot category.

', 'BoxPlotChartConfiguration$PrimaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, axis step) of a box plot category.

', 'ComboChartConfiguration$CategoryAxis' => '

The category axis of a combo chart.

', 'ComboChartConfiguration$PrimaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of a combo chart\'s primary y-axis (bar) field well.

', 'ComboChartConfiguration$SecondaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, axis step) of a combo chart\'s secondary y-axis (line) field well.

', 'HistogramConfiguration$XAxisDisplayOptions' => '

The options that determine the presentation of the x-axis.

', 'HistogramConfiguration$YAxisDisplayOptions' => '

The options that determine the presentation of the y-axis.

', 'LineChartConfiguration$XAxisDisplayOptions' => '

The options that determine the presentation of the x-axis.

', 'LineSeriesAxisDisplayOptions$AxisOptions' => '

The options that determine the presentation of the line series axis.

', 'RadarChartConfiguration$CategoryAxis' => '

The category axis of a radar chart.

', 'RadarChartConfiguration$ColorAxis' => '

The color axis of a radar chart.

', 'ScatterPlotConfiguration$XAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of the scatter plot\'s x-axis.

', 'ScatterPlotConfiguration$YAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of the scatter plot\'s y-axis.

', 'WaterfallChartConfiguration$CategoryAxisDisplayOptions' => '

The options that determine the presentation of the category axis.

', 'WaterfallChartConfiguration$PrimaryYAxisDisplayOptions' => '

The options that determine the presentation of the y-axis.

', ], ], 'AxisDisplayRange' => [ 'base' => '

The range setup of a numeric axis display range.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'NumericAxisOptions$Range' => '

The range setup of a numeric axis.

', ], ], 'AxisLabelOptions' => [ 'base' => '

The label options for a chart axis. You must specify the field that the label is targeted to.

', 'refs' => [ 'AxisLabelOptionsList$member' => NULL, ], ], 'AxisLabelOptionsList' => [ 'base' => NULL, 'refs' => [ 'ChartAxisLabelOptions$AxisLabelOptions' => '

The label options for a chart axis.

', ], ], 'AxisLabelReferenceOptions' => [ 'base' => '

The reference that specifies where the axis label is applied to.

', 'refs' => [ 'AxisLabelOptions$ApplyTo' => '

The options that indicate which field the label belongs to.

', ], ], 'AxisLinearScale' => [ 'base' => '

The liner axis scale setup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AxisScale$Linear' => '

The linear axis scale setup.

', ], ], 'AxisLogarithmicScale' => [ 'base' => '

The logarithmic axis scale setup.

', 'refs' => [ 'AxisScale$Logarithmic' => '

The logarithmic axis scale setup.

', ], ], 'AxisScale' => [ 'base' => '

The scale setup options for a numeric axis display.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'NumericAxisOptions$Scale' => '

The scale setup of a numeric axis.

', ], ], 'AxisTickLabelOptions' => [ 'base' => '

The tick label options of an axis.

', 'refs' => [ 'AxisDisplayOptions$TickLabelOptions' => '

The tick label options of an axis.

', ], ], 'BarChartAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a bar chart.

', 'refs' => [ 'BarChartFieldWells$BarChartAggregatedFieldWells' => '

The aggregated field wells of a bar chart.

', ], ], 'BarChartConfiguration' => [ 'base' => '

The configuration of a BarChartVisual.

', 'refs' => [ 'BarChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'BarChartFieldWells' => [ 'base' => '

The field wells of a BarChartVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'BarChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'BarChartOrientation' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$Orientation' => '

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

', ], ], 'BarChartSortConfiguration' => [ 'base' => '

sort-configuration-description

', 'refs' => [ 'BarChartConfiguration$SortConfiguration' => '

The sort configuration of a BarChartVisual.

', ], ], 'BarChartVisual' => [ 'base' => '

A bar chart.

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

For more information, see Using bar charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$BarChartVisual' => '

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

', ], ], 'BarsArrangement' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$BarsArrangement' => '

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

', 'ComboChartConfiguration$BarsArrangement' => '

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

', ], ], 'BaseMapStyleType' => [ 'base' => NULL, 'refs' => [ 'GeospatialMapStyleOptions$BaseMapStyle' => '

The base map style of the geospatial map.

', ], ], 'BatchCreateTopicReviewedAnswerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreateTopicReviewedAnswerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTopicReviewedAnswerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTopicReviewedAnswerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BigQueryParameters' => [ 'base' => '

The parameters that are required to connect to a Google BigQuery data source.

', 'refs' => [ 'DataSourceParameters$BigQueryParameters' => '

The parameters that are required to connect to a Google BigQuery data source.

', ], ], 'BinCountLimit' => [ 'base' => NULL, 'refs' => [ 'BinWidthOptions$BinCountLimit' => '

The options that determine the bin count limit.

', ], ], 'BinCountOptions' => [ 'base' => '

The options that determine the bin count of a histogram.

', 'refs' => [ 'HistogramBinOptions$BinCount' => '

The options that determine the bin count of a histogram.

', ], ], 'BinCountValue' => [ 'base' => NULL, 'refs' => [ 'BinCountOptions$Value' => '

The options that determine the bin count value.

', ], ], 'BinWidthOptions' => [ 'base' => '

The options that determine the bin width of a histogram.

', 'refs' => [ 'HistogramBinOptions$BinWidth' => '

The options that determine the bin width of a histogram.

', ], ], 'BinWidthValue' => [ 'base' => NULL, 'refs' => [ 'BinWidthOptions$Value' => '

The options that determine the bin width value.

', ], ], 'BodySectionConfiguration' => [ 'base' => '

The configuration of a body section.

', 'refs' => [ 'BodySectionConfigurationList$member' => NULL, ], ], 'BodySectionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutConfiguration$BodySections' => '

A list of body section configurations.

', ], ], 'BodySectionContent' => [ 'base' => '

The configuration of content in a body section.

', 'refs' => [ 'BodySectionConfiguration$Content' => '

The configuration of content in a body section.

', ], ], 'BodySectionDynamicCategoryDimensionConfiguration' => [ 'base' => '

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

', 'refs' => [ 'BodySectionRepeatDimensionConfiguration$DynamicCategoryDimensionConfiguration' => '

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

', ], ], 'BodySectionDynamicDimensionLimit' => [ 'base' => NULL, 'refs' => [ 'BodySectionDynamicCategoryDimensionConfiguration$Limit' => '

Number of values to use from the column for repetition.

', 'BodySectionDynamicNumericDimensionConfiguration$Limit' => '

Number of values to use from the column for repetition.

', ], ], 'BodySectionDynamicDimensionSortConfigurationList' => [ 'base' => NULL, 'refs' => [ 'BodySectionDynamicCategoryDimensionConfiguration$SortByMetrics' => '

Sort criteria on the column values that you use for repetition.

', 'BodySectionDynamicNumericDimensionConfiguration$SortByMetrics' => '

Sort criteria on the column values that you use for repetition.

', ], ], 'BodySectionDynamicNumericDimensionConfiguration' => [ 'base' => '

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

', 'refs' => [ 'BodySectionRepeatDimensionConfiguration$DynamicNumericDimensionConfiguration' => '

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

', ], ], 'BodySectionRepeatConfiguration' => [ 'base' => '

Describes the configurations that are required to declare a section as repeating.

', 'refs' => [ 'BodySectionConfiguration$RepeatConfiguration' => '

Describes the configurations that are required to declare a section as repeating.

', ], ], 'BodySectionRepeatDimensionConfiguration' => [ 'base' => '

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

', 'refs' => [ 'BodySectionRepeatDimensionConfigurationList$member' => NULL, ], ], 'BodySectionRepeatDimensionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'BodySectionRepeatConfiguration$DimensionConfigurations' => '

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

', ], ], 'BodySectionRepeatPageBreakConfiguration' => [ 'base' => '

The page break configuration to apply for each repeating instance.

', 'refs' => [ 'BodySectionRepeatConfiguration$PageBreakConfiguration' => '

Page break configuration to apply for each repeating instance.

', ], ], 'BookmarksConfigurations' => [ 'base' => '

The bookmarks configuration of an embedded dashboard.

', 'refs' => [ 'RegisteredUserDashboardFeatureConfigurations$Bookmarks' => '

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$PublicSharingEnabled' => '

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.

', 'AccountSettings$TerminationProtectionEnabled' => '

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.

', 'AssetBundleExportJobResourceIdOverrideConfiguration$PrefixForAllResources' => '

An option to request a CloudFormation variable for a prefix to be prepended to each resource\'s ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

', 'AssetBundleExportJobSummary$IncludeAllDependencies' => '

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

', 'AssetBundleExportJobSummary$IncludePermissions' => '

The flag that determines the inclusion of permissions associated with each resource ARN.

', 'AssetBundleExportJobSummary$IncludeTags' => '

The flag that determines the inclusion of tags associated with each resource ARN.

', 'AssetBundleExportJobValidationStrategy$StrictModeForAllResources' => '

A Boolean value that indicates whether to export resources under strict or lenient mode.

', 'AssetBundleImportJobOverrideValidationStrategy$StrictModeForAllResources' => '

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

', 'BookmarksConfigurations$Enabled' => '

A Boolean value that determines whether a user can bookmark an embedded dashboard.

', 'BorderStyle$Show' => '

The option to enable display of borders for visuals.

', 'DataSetSummary$RowLevelPermissionTagConfigurationApplied' => '

Whether or not the row level permission tags are applied.

', 'DataSetSummary$ColumnLevelPermissionRulesApplied' => '

A value that indicates if the dataset has column level permission configured.

', 'DataSetUsageConfiguration$DisableUseAsDirectQuerySource' => '

An option that controls whether a child dataset of a direct query can use this dataset as a source.

', 'DataSetUsageConfiguration$DisableUseAsImportedSource' => '

An option that controls whether a child dataset that\'s stored in QuickSight can use this dataset as a source.

', 'DeleteAnalysisRequest$ForceDeleteWithoutRecovery' => '

This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can\'t restore an analysis after it\'s deleted.

', 'DescribeAssetBundleExportJobResponse$IncludeAllDependencies' => '

The include dependencies flag.

', 'DescribeAssetBundleExportJobResponse$IncludePermissions' => '

The include permissions flag.

', 'DescribeAssetBundleExportJobResponse$IncludeTags' => '

The include tags flag.

', 'DescribeKeyRegistrationRequest$DefaultKeyOnly' => '

Determines whether the request returns the default key only.

', 'DisplayFormatOptions$UseBlankCellFormat' => '

A Boolean value that indicates whether to use blank cell format.

', 'DisplayFormatOptions$UseGrouping' => '

A Boolean value that indicates whether to use grouping.

', 'FailedKeyRegistrationEntry$SenderFault' => '

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.

', 'GetDashboardEmbedUrlRequest$UndoRedoDisabled' => '

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

', 'GetDashboardEmbedUrlRequest$ResetDisabled' => '

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

', 'GetDashboardEmbedUrlRequest$StatePersistenceEnabled' => '

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.

', 'GutterStyle$Show' => '

This Boolean value controls whether to display a gutter space between sheet tiles.

', 'IdentityCenterConfiguration$EnableIdentityPropagation' => '

A Boolean option that controls whether Trusted Identity Propagation should be used.

', 'JoinKeyProperties$UniqueKey' => '

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.

', 'MarginStyle$Show' => '

This Boolean value controls whether to display sheet margins.

', 'NestedFilter$IncludeInnerSet' => '

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

', 'NumericRangeFilter$IncludeMinimum' => '

Determines whether the minimum value in the filter value range should be included in the filtered results.

', 'NumericRangeFilter$IncludeMaximum' => '

Determines whether the maximum value in the filter value range should be included in the filtered results.

', 'RedshiftIAMParameters$AutoCreateDatabaseUser' => '

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.

', 'RegisteredCustomerManagedKey$DefaultKey' => '

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

', 'SharedViewConfigurations$Enabled' => '

The shared view settings of an embedded dashboard.

', 'SignupResponse$IAMUser' => '

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.

', 'SslProperties$DisableSsl' => '

A Boolean option to control whether SSL should be disabled.

', 'StartAssetBundleExportJobRequest$IncludeAllDependencies' => '

A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

', 'StartAssetBundleExportJobRequest$IncludePermissions' => '

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

', 'StartAssetBundleExportJobRequest$IncludeTags' => '

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

', 'StatePersistenceConfigurations$Enabled' => '

Determines if a Amazon QuickSight dashboard\'s state persistence settings are turned on or off.

', 'TimeRangeFilter$IncludeMinimum' => '

Determines whether the minimum value in the filter value range should be included in the filtered results.

', 'TimeRangeFilter$IncludeMaximum' => '

Determines whether the maximum value in the filter value range should be included in the filtered results.

', 'TopicCalculatedField$IsIncludedInTopic' => '

A boolean value that indicates if a calculated field is included in the topic.

', 'TopicCalculatedField$NeverAggregateInFilter' => '

A Boolean value that indicates whether to never aggregate calculated field in filters.

', 'TopicCategoryFilter$Inverse' => '

A Boolean value that indicates if the filter is inverse.

', 'TopicColumn$IsIncludedInTopic' => '

A Boolean value that indicates whether the column is included in the query results.

', 'TopicColumn$NeverAggregateInFilter' => '

A Boolean value that indicates whether to aggregate the column data when it\'s used in a filter context.

', 'TopicDateRangeFilter$Inclusive' => '

A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.

', 'TopicIRFilterOption$Inverse' => '

The inverse for the TopicIRFilterOption.

', 'TopicIRFilterOption$Inclusive' => '

The inclusive for the TopicIRFilterOption.

', 'TopicNumericRangeFilter$Inclusive' => '

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

', 'TopicRefreshSchedule$BasedOnSpiceSchedule' => '

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

', 'UpdateAccountSettingsRequest$TerminationProtectionEnabled' => '

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.

', 'UpdatePublicSharingSettingsRequest$PublicSharingEnabled' => '

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

', 'UpdateUserRequest$UnapplyCustomPermissions' => '

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn\'t accept any other value.

', 'UploadSettings$ContainsHeader' => '

Whether the file has a header row, or the files each have a header row.

', 'User$Active' => '

The active status of user. When you create an Amazon QuickSight user that\'s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'CustomValuesConfiguration$IncludeNullValue' => '

Includes the null value in custom action parameter values.

', ], ], 'BorderStyle' => [ 'base' => '

The display options for tile borders for visuals.

', 'refs' => [ 'TileStyle$Border' => '

The border around a tile.

', ], ], 'BoxPlotAggregatedFieldWells' => [ 'base' => '

The aggregated field well for a box plot.

', 'refs' => [ 'BoxPlotFieldWells$BoxPlotAggregatedFieldWells' => '

The aggregated field wells of a box plot.

', ], ], 'BoxPlotChartConfiguration' => [ 'base' => '

The configuration of a BoxPlotVisual.

', 'refs' => [ 'BoxPlotVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'BoxPlotDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BoxPlotAggregatedFieldWells$GroupBy' => '

The group by field well of a box plot chart. Values are grouped based on group by fields.

', ], ], 'BoxPlotFieldWells' => [ 'base' => '

The field wells of a BoxPlotVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'BoxPlotChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'BoxPlotFillStyle' => [ 'base' => NULL, 'refs' => [ 'BoxPlotStyleOptions$FillStyle' => '

The fill styles (solid, transparent) of the box plot.

', ], ], 'BoxPlotMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'BoxPlotAggregatedFieldWells$Values' => '

The value field well of a box plot chart. Values are aggregated based on group by fields.

', ], ], 'BoxPlotOptions' => [ 'base' => '

The options of a box plot visual.

', 'refs' => [ 'BoxPlotChartConfiguration$BoxPlotOptions' => '

The box plot chart options for a box plot visual

', ], ], 'BoxPlotSortConfiguration' => [ 'base' => '

The sort configuration of a BoxPlotVisual.

', 'refs' => [ 'BoxPlotChartConfiguration$SortConfiguration' => '

The sort configuration of a BoxPlotVisual.

', ], ], 'BoxPlotStyleOptions' => [ 'base' => '

The style options of the box plot.

', 'refs' => [ 'BoxPlotOptions$StyleOptions' => '

The style options of the box plot.

', ], ], 'BoxPlotVisual' => [ 'base' => '

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$BoxPlotVisual' => '

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'IpRestrictionRuleMap$key' => NULL, ], ], 'CalculatedColumn' => [ 'base' => '

A calculated column for a dataset.

', 'refs' => [ 'CalculatedColumnList$member' => NULL, ], ], 'CalculatedColumnList' => [ 'base' => NULL, 'refs' => [ 'CreateColumnsOperation$Columns' => '

Calculated columns to create.

', ], ], 'CalculatedField' => [ 'base' => '

The calculated field of an analysis.

', 'refs' => [ 'CalculatedFields$member' => NULL, ], ], 'CalculatedFieldExpression' => [ 'base' => NULL, 'refs' => [ 'CalculatedField$Expression' => '

The expression of the calculated field.

', ], ], 'CalculatedFieldReferenceList' => [ 'base' => NULL, 'refs' => [ 'TopicIRMetric$CalculatedFieldReferences' => '

The calculated field references for the TopicIRMetric.

', ], ], 'CalculatedFields' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$CalculatedFields' => '

An array of calculated field definitions for the analysis.

', 'DashboardVersionDefinition$CalculatedFields' => '

An array of calculated field definitions for the dashboard.

', 'TemplateVersionDefinition$CalculatedFields' => '

An array of calculated field definitions for the template.

', ], ], 'CalculatedMeasureField' => [ 'base' => '

The table calculation measure field for pivot tables.

', 'refs' => [ 'MeasureField$CalculatedMeasureField' => '

The calculated measure field only used in pivot tables.

', ], ], 'CancelIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CascadingControlConfiguration' => [ 'base' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'refs' => [ 'FilterCrossSheetControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'FilterDropDownControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'FilterListControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'ParameterDropDownControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'ParameterListControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', ], ], 'CascadingControlSource' => [ 'base' => '

The source controls that are used in a CascadingControlConfiguration.

', 'refs' => [ 'CascadingControlSourceList$member' => NULL, ], ], 'CascadingControlSourceList' => [ 'base' => NULL, 'refs' => [ 'CascadingControlConfiguration$SourceControls' => '

A list of source controls that determine the values that are used in the current control.

', ], ], 'CastColumnTypeOperation' => [ 'base' => '

A transform operation that casts a column to a different type.

', 'refs' => [ 'TransformOperation$CastColumnTypeOperation' => '

A transform operation that casts a column to a different type.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'PrestoParameters$Catalog' => '

Catalog.

', 'StarburstParameters$Catalog' => '

The catalog name for the Starburst data source.

', 'TrinoParameters$Catalog' => '

The catalog name for the Trino data source.

', ], ], 'CategoricalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AggregationFunction$CategoricalAggregationFunction' => '

Aggregation for categorical values.

', 'CategoricalMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', ], ], 'CategoricalDimensionField' => [ 'base' => '

The dimension type field with categorical type columns..

', 'refs' => [ 'DimensionField$CategoricalDimensionField' => '

The dimension type field with categorical type columns.

', ], ], 'CategoricalMeasureField' => [ 'base' => '

The measure type field with categorical type columns.

', 'refs' => [ 'MeasureField$CategoricalMeasureField' => '

The measure type field with categorical type columns.

', ], ], 'CategoryDrillDownFilter' => [ 'base' => '

The category drill down filter.

', 'refs' => [ 'DrillDownFilter$CategoryFilter' => '

The category type drill down filter. This filter is used for string type columns.

', ], ], 'CategoryFilter' => [ 'base' => '

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

', 'refs' => [ 'Filter$CategoryFilter' => '

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

', ], ], 'CategoryFilterConfiguration' => [ 'base' => '

The configuration for a CategoryFilter.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CategoryFilter$Configuration' => '

The configuration for a CategoryFilter.

', 'CategoryInnerFilter$Configuration' => NULL, ], ], 'CategoryFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicCategoryFilter$CategoryFilterFunction' => '

The category filter function. Valid values for this structure are EXACT and CONTAINS.

', ], ], 'CategoryFilterMatchOperator' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', 'CustomFilterListConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', 'FilterListConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', ], ], 'CategoryFilterSelectAllOptions' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'CustomFilterListConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'FilterListConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', ], ], 'CategoryFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicCategoryFilter$CategoryFilterType' => '

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

', ], ], 'CategoryInnerFilter' => [ 'base' => '

A CategoryInnerFilter filters text values for the NestedFilter.

', 'refs' => [ 'InnerFilter$CategoryInnerFilter' => '

A CategoryInnerFilter filters text values for the NestedFilter.

', ], ], 'CategoryValue' => [ 'base' => NULL, 'refs' => [ 'CategoryValueList$member' => NULL, 'CustomFilterConfiguration$CategoryValue' => '

The category value for the filter.

This field is mutually exclusive to ParameterName.

', ], ], 'CategoryValueList' => [ 'base' => NULL, 'refs' => [ 'CategoryDrillDownFilter$CategoryValues' => '

A list of the string inputs that are the values of the category drill down filter.

', 'CustomFilterListConfiguration$CategoryValues' => '

The list of category values for the filter.

', 'FilterListConfiguration$CategoryValues' => '

The list of category values for the filter.

', ], ], 'CellValueSynonym' => [ 'base' => '

A structure that represents the cell value synonym.

', 'refs' => [ 'CellValueSynonyms$member' => NULL, ], ], 'CellValueSynonyms' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$CellValueSynonyms' => '

The other names or aliases for the calculated field cell value.

', 'TopicColumn$CellValueSynonyms' => '

The other names or aliases for the column cell value.

', ], ], 'ChartAxisLabelOptions' => [ 'base' => '

The label options for an axis on a chart.

', 'refs' => [ 'BarChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a bar chart.

', 'BarChartConfiguration$ValueLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

', 'BarChartConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

', 'BoxPlotChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

', 'BoxPlotChartConfiguration$PrimaryYAxisLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) of a box plot value.

', 'ComboChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

', 'ComboChartConfiguration$PrimaryYAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s primary y-axis (bar) field well.

', 'ComboChartConfiguration$SecondaryYAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s secondary y-axis(line) field well.

', 'ComboChartConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s color field well.

', 'FunnelChartConfiguration$CategoryLabelOptions' => '

The label options of the categories that are displayed in a FunnelChartVisual.

', 'FunnelChartConfiguration$ValueLabelOptions' => '

The label options for the values that are displayed in a FunnelChartVisual.

', 'HeatMapConfiguration$RowLabelOptions' => '

The label options of the row that is displayed in a heat map.

', 'HeatMapConfiguration$ColumnLabelOptions' => '

The label options of the column that is displayed in a heat map.

', 'HistogramConfiguration$XAxisLabelOptions' => '

The options that determine the presentation of the x-axis label.

', 'LineChartConfiguration$XAxisLabelOptions' => '

The options that determine the presentation of the x-axis label.

', 'LineChartConfiguration$PrimaryYAxisLabelOptions' => '

The options that determine the presentation of the y-axis label.

', 'LineChartConfiguration$SecondaryYAxisLabelOptions' => '

The options that determine the presentation of the secondary y-axis label.

', 'PieChartConfiguration$CategoryLabelOptions' => '

The label options of the group/color that is displayed in a pie chart.

', 'PieChartConfiguration$ValueLabelOptions' => '

The label options for the value that is displayed in a pie chart.

', 'RadarChartConfiguration$CategoryLabelOptions' => '

The category label options of a radar chart.

', 'RadarChartConfiguration$ColorLabelOptions' => '

The color label options of a radar chart.

', 'ScatterPlotConfiguration$XAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of the scatter plot\'s x-axis.

', 'ScatterPlotConfiguration$YAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of the scatter plot\'s y-axis.

', 'TreeMapConfiguration$GroupLabelOptions' => '

The label options (label text, label visibility) of the groups that are displayed in a tree map.

', 'TreeMapConfiguration$SizeLabelOptions' => '

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

', 'TreeMapConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility) for the colors displayed in a tree map.

', 'WaterfallChartConfiguration$CategoryAxisLabelOptions' => '

The options that determine the presentation of the category axis label.

', 'WaterfallChartConfiguration$PrimaryYAxisLabelOptions' => '

The options that determine the presentation of the y-axis label.

', 'WordCloudChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

', ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'RedshiftParameters$ClusterId' => '

Cluster ID. This field can be blank if the Host and Port are provided.

', ], ], 'ClusterMarker' => [ 'base' => '

The cluster marker that is a part of the cluster marker configuration.

', 'refs' => [ 'ClusterMarkerConfiguration$ClusterMarker' => '

The cluster marker that is a part of the cluster marker configuration.

', ], ], 'ClusterMarkerConfiguration' => [ 'base' => '

The cluster marker configuration of the geospatial map selected point style.

', 'refs' => [ 'GeospatialPointStyleOptions$ClusterMarkerConfiguration' => '

The cluster marker configuration of the geospatial point style.

', ], ], 'CollectiveConstant' => [ 'base' => '

A structure that represents a collective constant.

', 'refs' => [ 'TopicCategoryFilterConstant$CollectiveConstant' => '

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

', ], ], 'CollectiveConstantEntry' => [ 'base' => '

The definition for a CollectiveConstantEntry.

', 'refs' => [ 'CollectiveConstantEntryList$member' => NULL, ], ], 'CollectiveConstantEntryList' => [ 'base' => NULL, 'refs' => [ 'TopicConstantValue$ValueList' => '

The value list of the TopicConstantValue.

', ], ], 'ColorFillType' => [ 'base' => NULL, 'refs' => [ 'ColorScale$ColorFillType' => '

Determines the color fill type.

', ], ], 'ColorList' => [ 'base' => NULL, 'refs' => [ 'DataColorPalette$Colors' => '

The hexadecimal codes for the colors.

', 'DataColorPalette$MinMaxGradient' => '

The minimum and maximum hexadecimal codes that describe a color gradient.

', ], ], 'ColorScale' => [ 'base' => '

Determines the color scale that is applied to the visual.

', 'refs' => [ 'HeatMapConfiguration$ColorScale' => '

The color options (gradient color, point of divergence) in a heat map.

', 'TreeMapConfiguration$ColorScale' => '

The color options (gradient color, point of divergence) of a tree map.

', ], ], 'ColorScaleColorList' => [ 'base' => NULL, 'refs' => [ 'ColorScale$Colors' => '

Determines the list of colors that are applied to the visual.

', ], ], 'ColorsConfiguration' => [ 'base' => '

The color configurations for a column.

', 'refs' => [ 'ColumnConfiguration$ColorsConfiguration' => '

The color configurations of the column.

', ], ], 'ColumnConfiguration' => [ 'base' => '

The general configuration of a column.

', 'refs' => [ 'ColumnConfigurationList$member' => NULL, ], ], 'ColumnConfigurationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$ColumnConfigurations' => '

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

', 'DashboardVersionDefinition$ColumnConfigurations' => '

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

', 'TemplateVersionDefinition$ColumnConfigurations' => '

An array of template-level column configurations. Column configurations are used to set default formatting for a column that\'s used throughout a template.

', ], ], 'ColumnDataRole' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$ColumnDataRole' => '

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

', 'TopicColumn$ColumnDataRole' => '

The role of the column in the data. Valid values are DIMENSION and MEASURE.

', ], ], 'ColumnDataSubType' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$SubType' => '

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

', 'InputColumn$SubType' => '

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

', 'OutputColumn$SubType' => '

The sub data type of the column.

', ], ], 'ColumnDataType' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$NewColumnType' => '

New column data type.

', 'OutputColumn$Type' => '

The data type of the column.

', ], ], 'ColumnDescription' => [ 'base' => '

Metadata that contains a description for a column.

', 'refs' => [ 'ColumnTag$ColumnDescription' => '

A description for a column.

', ], ], 'ColumnDescriptiveText' => [ 'base' => NULL, 'refs' => [ 'ColumnDescription$Text' => '

The text of a description for a column.

', 'OutputColumn$Description' => '

A description for a column.

', ], ], 'ColumnGroup' => [ 'base' => '

Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'ColumnGroupList$member' => NULL, ], ], 'ColumnGroupColumnSchema' => [ 'base' => '

A structure describing the name, data type, and geographic role of the columns.

', 'refs' => [ 'ColumnGroupColumnSchemaList$member' => NULL, ], ], 'ColumnGroupColumnSchemaList' => [ 'base' => NULL, 'refs' => [ 'ColumnGroupSchema$ColumnGroupColumnSchemaList' => '

A structure containing the list of schemas for column group columns.

', ], ], 'ColumnGroupList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', 'DataSet$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', 'UpdateDataSetRequest$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', ], ], 'ColumnGroupName' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$Name' => '

A display name for the hierarchy.

', ], ], 'ColumnGroupSchema' => [ 'base' => '

The column group schema.

', 'refs' => [ 'ColumnGroupSchemaList$member' => NULL, ], ], 'ColumnGroupSchemaList' => [ 'base' => NULL, 'refs' => [ 'DataSetConfiguration$ColumnGroupSchemaList' => '

A structure containing the list of column group schemas.

', ], ], 'ColumnHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields for a visual element.

', 'refs' => [ 'ColumnHierarchyList$member' => NULL, ], ], 'ColumnHierarchyList' => [ 'base' => NULL, 'refs' => [ 'BarChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'BoxPlotVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'ComboChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'FilledMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'FunnelChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'GeospatialMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'HeatMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'KPIVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'LineChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'PieChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'RadarChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'ScatterPlotVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'TreeMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'WaterfallVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'WordCloudVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', ], ], 'ColumnId' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$ColumnId' => '

A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.

', ], ], 'ColumnIdentifier' => [ 'base' => '

A column of a data set.

', 'refs' => [ 'AggregationSortConfiguration$Column' => '

The column that determines the sort order of aggregated values.

', 'AxisLabelReferenceOptions$Column' => '

The column that the axis label is targeted to.

', 'BodySectionDynamicCategoryDimensionConfiguration$Column' => NULL, 'BodySectionDynamicNumericDimensionConfiguration$Column' => NULL, 'CascadingControlSource$ColumnToMatch' => '

The column identifier that determines which column to look up for the source sheet control.

', 'CategoricalDimensionField$Column' => '

The column that is used in the CategoricalDimensionField.

', 'CategoricalMeasureField$Column' => '

The column that is used in the CategoricalMeasureField.

', 'CategoryDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'CategoryFilter$Column' => '

The column that the filter is applied to.

', 'CategoryInnerFilter$Column' => NULL, 'ColumnConfiguration$Column' => '

The column.

', 'ColumnSort$SortBy' => NULL, 'ColumnTooltipItem$Column' => '

The target column of the tooltip item.

', 'ContributorDimensionList$member' => NULL, 'CustomActionColumnList$member' => NULL, 'DateDimensionField$Column' => '

The column that is used in the DateDimensionField.

', 'DateMeasureField$Column' => '

The column that is used in the DateMeasureField.

', 'DestinationParameterValueConfiguration$SourceColumn' => NULL, 'DynamicDefaultValue$UserNameColumn' => '

The column that contains the username.

', 'DynamicDefaultValue$GroupNameColumn' => '

The column that contains the group name.

', 'DynamicDefaultValue$DefaultValueColumn' => '

The column that contains the default value of each user or group.

', 'ExplicitHierarchyColumnList$member' => NULL, 'NestedFilter$Column' => '

The column that the filter is applied to.

', 'NumericEqualityDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'NumericEqualityFilter$Column' => '

The column that the filter is applied to.

', 'NumericRangeFilter$Column' => '

The column that the filter is applied to.

', 'NumericalDimensionField$Column' => '

The column that is used in the NumericalDimensionField.

', 'NumericalMeasureField$Column' => '

The column that is used in the NumericalMeasureField.

', 'ParameterSelectableValues$LinkToDataSetColumn' => '

The column identifier that fetches values from the data set.

', 'PredefinedHierarchyColumnList$member' => NULL, 'ReferenceLineDynamicDataConfiguration$Column' => '

The column that the dynamic data targets.

', 'RelativeDatesFilter$Column' => '

The column that the filter is applied to.

', 'TimeEqualityFilter$Column' => '

The column that the filter is applied to.

', 'TimeRangeDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'TimeRangeFilter$Column' => '

The column that the filter is applied to.

', 'TopBottomFilter$Column' => '

The column that the filter is applied to.

', 'UnaggregatedField$Column' => '

The column that is used in the UnaggregatedField.

', ], ], 'ColumnLevelPermissionRule' => [ 'base' => '

A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

', 'refs' => [ 'ColumnLevelPermissionRuleList$member' => NULL, ], ], 'ColumnLevelPermissionRuleList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', 'DataSet$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', 'UpdateDataSetRequest$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', ], ], 'ColumnList' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$Columns' => '

Columns in this hierarchy.

', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$ColumnName' => '

Column name.

', 'CalculatedField$Name' => '

The name of the calculated field.

', 'CastColumnTypeOperation$ColumnName' => '

Column name.

', 'ColumnIdentifier$ColumnName' => '

The name of the column.

', 'ColumnList$member' => NULL, 'InputColumn$Name' => '

The name of this column in the underlying data source.

', 'OutputColumn$Name' => '

The display name of the column..

', 'RenameColumnOperation$ColumnName' => '

The name of the column to be renamed.

', 'RenameColumnOperation$NewColumnName' => '

The new name for the column.

', 'TagColumnOperation$ColumnName' => '

The column that this operation acts on.

', 'UntagColumnOperation$ColumnName' => '

The column that this operation acts on.

', ], ], 'ColumnNameList' => [ 'base' => NULL, 'refs' => [ 'ColumnLevelPermissionRule$ColumnNames' => '

An array of column names.

', ], ], 'ColumnOrderingType' => [ 'base' => NULL, 'refs' => [ 'ComparativeOrder$UseOrdering' => '

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

', ], ], 'ColumnRole' => [ 'base' => NULL, 'refs' => [ 'ColumnConfiguration$Role' => '

The role of the column.

', ], ], 'ColumnSchema' => [ 'base' => '

The column schema.

', 'refs' => [ 'ColumnSchemaList$member' => NULL, ], ], 'ColumnSchemaList' => [ 'base' => NULL, 'refs' => [ 'DataSetSchema$ColumnSchemaList' => '

A structure containing the list of column schemas.

', ], ], 'ColumnSort' => [ 'base' => '

The sort configuration for a column that is not used in a field well.

', 'refs' => [ 'BodySectionDynamicDimensionSortConfigurationList$member' => NULL, 'FieldSortOptions$ColumnSort' => '

The sort configuration for a column that is not used in a field well.

', 'PivotTableSortBy$Column' => '

The column sort (field id, direction) for the pivot table sort by options.

', ], ], 'ColumnTag' => [ 'base' => '

A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'ColumnTagList$member' => NULL, ], ], 'ColumnTagList' => [ 'base' => NULL, 'refs' => [ 'TagColumnOperation$Tags' => '

The dataset column tag, currently only used for geospatial type tagging.

This is not tags for the Amazon Web Services tagging feature.

', ], ], 'ColumnTagName' => [ 'base' => NULL, 'refs' => [ 'ColumnTagNames$member' => NULL, ], ], 'ColumnTagNames' => [ 'base' => NULL, 'refs' => [ 'UntagColumnOperation$TagNames' => '

The column tags to remove from this column.

', ], ], 'ColumnTooltipItem' => [ 'base' => '

The tooltip item for the columns that are not part of a field well.

', 'refs' => [ 'TooltipItem$ColumnTooltipItem' => '

The tooltip item for the columns that are not part of a field well.

', ], ], 'ComboChartAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a combo chart.

', 'refs' => [ 'ComboChartFieldWells$ComboChartAggregatedFieldWells' => '

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

', ], ], 'ComboChartConfiguration' => [ 'base' => '

The configuration of a ComboChartVisual.

', 'refs' => [ 'ComboChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'ComboChartFieldWells' => [ 'base' => '

The field wells of the visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComboChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'ComboChartSortConfiguration' => [ 'base' => '

The sort configuration of a ComboChartVisual.

', 'refs' => [ 'ComboChartConfiguration$SortConfiguration' => '

The sort configuration of a ComboChartVisual.

', ], ], 'ComboChartVisual' => [ 'base' => '

A combo chart.

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

For more information, see Using combo charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$ComboChartVisual' => '

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

', ], ], 'ComparativeOrder' => [ 'base' => '

A structure that represents a comparative order.

', 'refs' => [ 'TopicCalculatedField$ComparativeOrder' => '

The order in which data is displayed for the calculated field when it\'s used in a comparative context.

', 'TopicColumn$ComparativeOrder' => '

The order in which data is displayed for the column when it\'s used in a comparative context.

', ], ], 'ComparisonConfiguration' => [ 'base' => '

The comparison display configuration of a KPI or gauge chart.

', 'refs' => [ 'GaugeChartOptions$Comparison' => '

The comparison configuration of a GaugeChartVisual.

', 'KPIOptions$Comparison' => '

The comparison configuration of a KPI visual.

', ], ], 'ComparisonFormatConfiguration' => [ 'base' => '

The format of the comparison.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComparisonConfiguration$ComparisonFormat' => '

The format of the comparison.

', ], ], 'ComparisonMethod' => [ 'base' => NULL, 'refs' => [ 'ComparisonConfiguration$ComparisonMethod' => '

The method of the comparison. Choose from the following options:

', ], ], 'ComparisonMethodType' => [ 'base' => NULL, 'refs' => [ 'TopicIRComparisonMethod$Type' => '

The type for the TopicIRComparisonMethod.

', ], ], 'Computation' => [ 'base' => '

The computation union that is used in an insight visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComputationList$member' => NULL, ], ], 'ComputationList' => [ 'base' => NULL, 'refs' => [ 'InsightConfiguration$Computations' => '

The computations configurations of the insight visual

', ], ], 'ConcurrentUpdatingException' => [ 'base' => '

A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.

', 'refs' => [], ], 'ConditionalFormattingColor' => [ 'base' => '

The formatting configuration for the color.

', 'refs' => [ 'GaugeChartArcConditionalFormatting$ForegroundColor' => '

The conditional formatting of the arc foreground color.

', 'GaugeChartPrimaryValueConditionalFormatting$TextColor' => '

The conditional formatting of the primary value text color.

', 'KPIActualValueConditionalFormatting$TextColor' => '

The conditional formatting of the actual value\'s text color.

', 'KPIComparisonValueConditionalFormatting$TextColor' => '

The conditional formatting of the comparison value\'s text color.

', 'KPIPrimaryValueConditionalFormatting$TextColor' => '

The conditional formatting of the primary value\'s text color.

', 'KPIProgressBarConditionalFormatting$ForegroundColor' => '

The conditional formatting of the progress bar\'s foreground color.

', 'ShapeConditionalFormat$BackgroundColor' => '

The conditional formatting for the shape background color of a filled map visual.

', 'TableRowConditionalFormatting$BackgroundColor' => '

The conditional formatting color (solid, gradient) of the background for a table row.

', 'TableRowConditionalFormatting$TextColor' => '

The conditional formatting color (solid, gradient) of the text for a table row.

', 'TextConditionalFormat$BackgroundColor' => '

The conditional formatting for the text background color.

', 'TextConditionalFormat$TextColor' => '

The conditional formatting for the text color.

', ], ], 'ConditionalFormattingCustomIconCondition' => [ 'base' => '

Determines the custom condition for an icon set.

', 'refs' => [ 'ConditionalFormattingIcon$CustomCondition' => '

Determines the custom condition for an icon set.

', ], ], 'ConditionalFormattingCustomIconOptions' => [ 'base' => '

Custom icon options for an icon set.

', 'refs' => [ 'ConditionalFormattingCustomIconCondition$IconOptions' => '

Custom icon options for an icon set.

', ], ], 'ConditionalFormattingGradientColor' => [ 'base' => '

Formatting configuration for gradient color.

', 'refs' => [ 'ConditionalFormattingColor$Gradient' => '

Formatting configuration for gradient color.

', ], ], 'ConditionalFormattingIcon' => [ 'base' => '

The formatting configuration for the icon.

', 'refs' => [ 'GaugeChartPrimaryValueConditionalFormatting$Icon' => '

The conditional formatting of the primary value icon.

', 'KPIActualValueConditionalFormatting$Icon' => '

The conditional formatting of the actual value\'s icon.

', 'KPIComparisonValueConditionalFormatting$Icon' => '

The conditional formatting of the comparison value\'s icon.

', 'KPIPrimaryValueConditionalFormatting$Icon' => '

The conditional formatting of the primary value\'s icon.

', 'TextConditionalFormat$Icon' => '

The conditional formatting for the icon.

', ], ], 'ConditionalFormattingIconDisplayConfiguration' => [ 'base' => '

Determines the icon display configuration.

', 'refs' => [ 'ConditionalFormattingCustomIconCondition$DisplayConfiguration' => '

Determines the icon display configuration.

', ], ], 'ConditionalFormattingIconDisplayOption' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingIconDisplayConfiguration$IconDisplayOption' => '

Determines the icon display configuration.

', ], ], 'ConditionalFormattingIconSet' => [ 'base' => '

Formatting configuration for icon set.

', 'refs' => [ 'ConditionalFormattingIcon$IconSet' => '

Formatting configuration for icon set.

', ], ], 'ConditionalFormattingIconSetType' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingIconSet$IconSetType' => '

Determines the icon set type.

', ], ], 'ConditionalFormattingSolidColor' => [ 'base' => '

Formatting configuration for solid color.

', 'refs' => [ 'ConditionalFormattingColor$Solid' => '

Formatting configuration for solid color.

', ], ], 'ConflictException' => [ 'base' => '

Updating or deleting a resource can cause an inconsistent state.

', 'refs' => [], ], 'ConstantType' => [ 'base' => NULL, 'refs' => [ 'CollectiveConstantEntry$ConstantType' => '

The ConstantType of a CollectiveConstantEntry.

', 'TopicCategoryFilterConstant$ConstantType' => '

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

', 'TopicConstantValue$ConstantType' => '

The constant type of a TopicConstantValue.

', 'TopicRangeFilterConstant$ConstantType' => '

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

', 'TopicSingularFilterConstant$ConstantType' => '

The type of the singular filter constant. Valid values for this structure are SINGULAR.

', ], ], 'ConstantValueString' => [ 'base' => NULL, 'refs' => [ 'CollectiveConstantEntry$Value' => '

The value of a CollectiveConstantEntry.

', 'TopicConstantValue$Value' => '

The value of the TopicConstantValue.

', 'TopicConstantValue$Minimum' => '

The minimum for the TopicConstantValue.

', 'TopicConstantValue$Maximum' => '

The maximum for the TopicConstantValue.

', ], ], 'ContextMenuOption' => [ 'base' => '

The context menu options for a visual\'s interactions.

', 'refs' => [ 'VisualInteractionOptions$ContextMenuOption' => '

The context menu options for a visual.

', ], ], 'ContributionAnalysisDefault' => [ 'base' => '

The contribution analysis visual display for a line, pie, or bar chart.

', 'refs' => [ 'ContributionAnalysisDefaultList$member' => NULL, ], ], 'ContributionAnalysisDefaultList' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$ContributionAnalysisDefaults' => '

The contribution analysis (anomaly configuration) setup of the visual.

', 'LineChartConfiguration$ContributionAnalysisDefaults' => '

The default configuration of a line chart\'s contribution analysis.

', 'PieChartConfiguration$ContributionAnalysisDefaults' => '

The contribution analysis (anomaly configuration) setup of the visual.

', ], ], 'ContributionAnalysisDirection' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$Direction' => '

The direction for the TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisFactor' => [ 'base' => '

The definition for the ContributionAnalysisFactor.

', 'refs' => [ 'ContributionAnalysisFactorsList$member' => NULL, ], ], 'ContributionAnalysisFactorsList' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$Factors' => '

The factors for a TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisSortType' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$SortType' => '

The sort type for the TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisTimeRanges' => [ 'base' => '

The definition for the ContributionAnalysisTimeRanges.

', 'refs' => [ 'TopicIRContributionAnalysis$TimeRanges' => '

The time ranges for the TopicIRContributionAnalysis.

', ], ], 'ContributorDimensionList' => [ 'base' => NULL, 'refs' => [ 'ContributionAnalysisDefault$ContributorDimensions' => '

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers.

', ], ], 'CopySourceArn' => [ 'base' => NULL, 'refs' => [ 'DataSourceCredentials$CopySourceArn' => '

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

', ], ], 'CreateAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateColumnsOperation' => [ 'base' => '

A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.

', 'refs' => [ 'TransformOperation$CreateColumnsOperation' => '

An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

', ], ], 'CreateDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupRequest' => [ 'base' => '

The request object for this operation.

', 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => '

The response object for this operation.

', 'refs' => [], ], 'CreateIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRoleMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRoleMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicReviewedAnswer' => [ 'base' => '

The definition for a CreateTopicReviewedAnswer.

', 'refs' => [ 'CreateTopicReviewedAnswers$member' => NULL, ], ], 'CreateTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$Answers' => '

The definition of the Answers to be created.

', ], ], 'CreateVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CredentialPair' => [ 'base' => '

The combination of user name and password that are used as credentials.

', 'refs' => [ 'DataSourceCredentials$CredentialPair' => '

Credential pair. For more information, see CredentialPair .

', ], ], 'CrossDatasetTypes' => [ 'base' => NULL, 'refs' => [ 'FilterGroup$CrossDataset' => '

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

', ], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Symbol' => '

Determines the symbol for the currency format.

', ], ], 'CurrencyDisplayFormatConfiguration' => [ 'base' => '

The options that determine the currency display format configuration.

', 'refs' => [ 'NumericFormatConfiguration$CurrencyDisplayFormatConfiguration' => '

The options that determine the currency display format configuration.

', ], ], 'CustomActionColumnList' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedColumns' => '

The selected columns of a dataset.

', ], ], 'CustomActionFilterOperation' => [ 'base' => '

The filter operation that filters data included in a visual or in an entire sheet.

', 'refs' => [ 'VisualCustomActionOperation$FilterOperation' => '

The filter operation that filters data included in a visual or in an entire sheet.

', ], ], 'CustomActionNavigationOperation' => [ 'base' => '

The navigation operation that navigates between different sheets in the same analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualCustomActionOperation$NavigationOperation' => '

The navigation operation that navigates between different sheets in the same analysis.

', ], ], 'CustomActionSetParametersOperation' => [ 'base' => '

The set parameter operation that sets parameters in custom action.

', 'refs' => [ 'VisualCustomActionOperation$SetParametersOperation' => '

The set parameter operation that sets parameters in custom action.

', ], ], 'CustomActionURLOperation' => [ 'base' => '

The URL operation that opens a link to another webpage.

', 'refs' => [ 'VisualCustomActionOperation$URLOperation' => '

The URL operation that opens a link to another webpage.

', ], ], 'CustomColor' => [ 'base' => '

Determines the color that\'s applied to a particular data value in a column.

', 'refs' => [ 'CustomColorsList$member' => NULL, ], ], 'CustomColorsList' => [ 'base' => NULL, 'refs' => [ 'ColorsConfiguration$CustomColors' => '

A list of up to 50 custom colors.

', ], ], 'CustomContentConfiguration' => [ 'base' => '

The configuration of a CustomContentVisual.

', 'refs' => [ 'CustomContentVisual$ChartConfiguration' => '

The configuration of a CustomContentVisual.

', ], ], 'CustomContentImageScalingConfiguration' => [ 'base' => NULL, 'refs' => [ 'CustomContentConfiguration$ImageScaling' => '

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is \'IMAGE\'.

', ], ], 'CustomContentType' => [ 'base' => NULL, 'refs' => [ 'CustomContentConfiguration$ContentType' => '

The content type of the custom content visual. You can use this to have the visual render as an image.

', ], ], 'CustomContentVisual' => [ 'base' => '

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$CustomContentVisual' => '

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

', ], ], 'CustomFilterConfiguration' => [ 'base' => '

A custom filter that filters based on a single value. This filter can be partially matched.

', 'refs' => [ 'CategoryFilterConfiguration$CustomFilterConfiguration' => '

A custom filter that filters based on a single value. This filter can be partially matched.

', ], ], 'CustomFilterListConfiguration' => [ 'base' => '

A list of custom filter values.

', 'refs' => [ 'CategoryFilterConfiguration$CustomFilterListConfiguration' => '

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

', ], ], 'CustomLabel' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOption$CustomLabel' => '

The custom label of the pivot table field.

', 'TableFieldOption$CustomLabel' => '

The custom label for a table field.

', ], ], 'CustomNarrativeOptions' => [ 'base' => '

The custom narrative options.

', 'refs' => [ 'InsightConfiguration$CustomNarrative' => '

The custom narrative of the insight visual.

', ], ], 'CustomParameterValues' => [ 'base' => '

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomValuesConfiguration$CustomValues' => NULL, ], ], 'CustomSql' => [ 'base' => '

A physical table type built from the results of the custom SQL query.

', 'refs' => [ 'PhysicalTable$CustomSql' => '

A physical table type built from the results of the custom SQL query.

', ], ], 'CustomSqlName' => [ 'base' => NULL, 'refs' => [ 'CustomSql$Name' => '

A display name for the SQL query result.

', ], ], 'CustomValuesConfiguration' => [ 'base' => '

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

', 'refs' => [ 'DestinationParameterValueConfiguration$CustomValuesConfiguration' => '

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

', ], ], 'CustomerManagedKeyUnavailableException' => [ 'base' => '

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

', 'refs' => [], ], 'Dashboard' => [ 'base' => '

Dashboard.

', 'refs' => [ 'DescribeDashboardResponse$Dashboard' => '

Information about the dashboard.

', ], ], 'DashboardBehavior' => [ 'base' => NULL, 'refs' => [ 'AdHocFilteringOption$AvailabilityStatus' => '

Availability status.

', 'ContextMenuOption$AvailabilityStatus' => '

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

', 'DataPointDrillUpDownOption$AvailabilityStatus' => '

The status of the drill down options of data points.

', 'DataPointMenuLabelOption$AvailabilityStatus' => '

The status of the data point menu options.

', 'DataPointTooltipOption$AvailabilityStatus' => '

The status of the data point tool tip options.

', 'ExportHiddenFieldsOption$AvailabilityStatus' => '

The status of the export hidden fields options of a dashbaord.

', 'ExportToCSVOption$AvailabilityStatus' => '

Availability status.

', 'ExportWithHiddenFieldsOption$AvailabilityStatus' => '

The status of the export with hidden fields options.

', 'SheetLayoutElementMaximizationOption$AvailabilityStatus' => '

The status of the sheet layout maximization options of a dashbaord.

', 'VisualAxisSortOption$AvailabilityStatus' => '

The availaiblity status of a visual\'s axis sort options.

', 'VisualMenuOption$AvailabilityStatus' => '

The availaiblity status of a visual\'s menu options.

', ], ], 'DashboardError' => [ 'base' => '

Dashboard error.

', 'refs' => [ 'DashboardErrorList$member' => NULL, ], ], 'DashboardErrorList' => [ 'base' => NULL, 'refs' => [ 'DashboardVersion$Errors' => '

Errors associated with this dashboard version.

', 'DescribeDashboardDefinitionResponse$Errors' => '

Errors associated with this dashboard version.

', ], ], 'DashboardErrorType' => [ 'base' => NULL, 'refs' => [ 'DashboardError$Type' => '

Type.

', ], ], 'DashboardFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DashboardSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DashboardName' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$Name' => '

The display name of the dashboard.

', 'Dashboard$Name' => '

A display name for the dashboard.

', 'DashboardSummary$Name' => '

A display name for the dashboard.

', 'DescribeDashboardDefinitionResponse$Name' => '

The display name of the dashboard.

', 'UpdateDashboardRequest$Name' => '

The display name of the dashboard.

', ], ], 'DashboardPublishOptions' => [ 'base' => '

Dashboard publish options.

', 'refs' => [ 'CreateDashboardRequest$DashboardPublishOptions' => '

Options for publishing the dashboard when you create it:

', 'DescribeDashboardDefinitionResponse$DashboardPublishOptions' => '

Options for publishing the dashboard:

', 'UpdateDashboardRequest$DashboardPublishOptions' => '

Options for publishing the dashboard when you create it:

', ], ], 'DashboardSearchFilter' => [ 'base' => '

A filter that you apply when searching for dashboards.

', 'refs' => [ 'DashboardSearchFilterList$member' => NULL, ], ], 'DashboardSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDashboardsRequest$Filters' => '

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

', ], ], 'DashboardSourceEntity' => [ 'base' => '

Dashboard source entity.

', 'refs' => [ 'CreateDashboardRequest$SourceEntity' => '

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 SourceTemplateARN 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.

', 'UpdateDashboardRequest$SourceEntity' => '

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.

', ], ], 'DashboardSourceTemplate' => [ 'base' => '

Dashboard source template.

', 'refs' => [ 'DashboardSourceEntity$SourceTemplate' => '

Source template.

', ], ], 'DashboardSummary' => [ 'base' => '

Dashboard summary.

', 'refs' => [ 'DashboardSummaryList$member' => NULL, ], ], 'DashboardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDashboardsResponse$DashboardSummaryList' => '

A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

', 'SearchDashboardsResponse$DashboardSummaryList' => '

The list of dashboards owned by the user specified in Filters in your request.

', ], ], 'DashboardUIState' => [ 'base' => NULL, 'refs' => [ 'SheetControlsOption$VisibilityState' => '

Visibility state.

', ], ], 'DashboardVersion' => [ 'base' => '

Dashboard version.

', 'refs' => [ 'Dashboard$Version' => '

Version.

', ], ], 'DashboardVersionDefinition' => [ 'base' => '

The contents of a dashboard.

', 'refs' => [ 'CreateDashboardRequest$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeDashboardDefinitionResponse$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateDashboardRequest$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'DashboardVersionSummary' => [ 'base' => '

Dashboard version summary.

', 'refs' => [ 'DashboardVersionSummaryList$member' => NULL, ], ], 'DashboardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDashboardVersionsResponse$DashboardVersionSummaryList' => '

A structure that contains information about each version of the dashboard.

', ], ], 'DashboardVisualId' => [ 'base' => '

A structure that contains the following elements:

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.

', 'refs' => [ 'AnonymousUserDashboardVisualEmbeddingConfiguration$InitialDashboardVisualId' => '

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.

', 'RegisteredUserDashboardVisualEmbeddingConfiguration$InitialDashboardVisualId' => '

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.

', ], ], 'DashboardVisualPublishOptions' => [ 'base' => '

The visual publish options of a visual in a dashboard

', 'refs' => [ 'DashboardPublishOptions$VisualPublishOptions' => '

The visual publish options of a visual in a dashboard.

', ], ], 'DataAggregation' => [ 'base' => '

A structure that represents a data aggregation.

', 'refs' => [ 'DatasetMetadata$DataAggregation' => '

The definition of a data aggregation.

', ], ], 'DataBarsOptions' => [ 'base' => '

The options for data bars.

', 'refs' => [ 'TableInlineVisualization$DataBars' => '

The configuration of the inline visualization of the data bars within a chart.

', ], ], 'DataColor' => [ 'base' => '

Determines the color that is applied to a particular data value.

', 'refs' => [ 'ColorScale$NullValueColor' => '

Determines the color that is applied to null values.

', 'ColorScaleColorList$member' => NULL, ], ], 'DataColorPalette' => [ 'base' => '

The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

', 'refs' => [ 'ThemeConfiguration$DataColorPalette' => '

Color properties that apply to chart data colors.

', ], ], 'DataFieldSeriesItem' => [ 'base' => '

The data field series item configuration of a line chart.

', 'refs' => [ 'SeriesItem$DataFieldSeriesItem' => '

The data field series item configuration of a line chart.

', ], ], 'DataLabelContent' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$LabelContent' => '

Determines the content of the data labels.

', ], ], 'DataLabelOptions' => [ 'base' => '

The options that determine the presentation of the data labels.

', 'refs' => [ 'BarChartConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'ComboChartConfiguration$BarDataLabels' => '

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

', 'ComboChartConfiguration$LineDataLabels' => '

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

', 'GaugeChartConfiguration$DataLabels' => '

The data label configuration of a GaugeChartVisual.

', 'HeatMapConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'HistogramConfiguration$DataLabels' => '

The data label configuration of a histogram.

', 'LineChartConfiguration$DataLabels' => '

The data label configuration of a line chart.

', 'PieChartConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'SankeyDiagramChartConfiguration$DataLabels' => '

The data label configuration of a sankey diagram.

', 'ScatterPlotConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'TreeMapConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'WaterfallChartConfiguration$DataLabels' => '

The data label configuration of a waterfall visual.

', ], ], 'DataLabelOverlap' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$Overlap' => '

Determines whether overlap is enabled or disabled for the data labels.

', ], ], 'DataLabelPosition' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$Position' => '

Determines the position of the data labels.

', 'FunnelChartDataLabelOptions$Position' => '

Determines the positioning of the data label relative to a section of the funnel.

', ], ], 'DataLabelType' => [ 'base' => '

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DataLabelTypes$member' => NULL, ], ], 'DataLabelTypes' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$DataLabelTypes' => '

The option that determines the data label type.

', ], ], 'DataPathColor' => [ 'base' => '

The color map that determines the color options for a particular element.

', 'refs' => [ 'DataPathColorList$member' => NULL, ], ], 'DataPathColorList' => [ 'base' => NULL, 'refs' => [ 'VisualPalette$ColorMap' => '

The color map options for the visual palette.

', ], ], 'DataPathLabelType' => [ 'base' => '

The option that specifies individual data values for labels.

', 'refs' => [ 'DataLabelType$DataPathLabelType' => '

The option that specifies individual data values for labels.

', ], ], 'DataPathSort' => [ 'base' => '

Allows data paths to be sorted by a specific data value.

', 'refs' => [ 'PivotTableSortBy$DataPath' => '

The data path sort (data path value, direction) for the pivot table sort by options.

', ], ], 'DataPathType' => [ 'base' => '

The type of the data path value.

', 'refs' => [ 'DataPathValue$DataPathType' => '

The type configuration of the field.

', ], ], 'DataPathValue' => [ 'base' => '

The data path that needs to be sorted.

', 'refs' => [ 'DataPathColor$Element' => '

The element that the color needs to be applied to.

', 'DataPathValueList$member' => NULL, ], ], 'DataPathValueList' => [ 'base' => NULL, 'refs' => [ 'DataPathSort$SortPaths' => '

The list of data paths that need to be sorted.

', 'PivotTableDataPathOption$DataPathList' => '

The list of data path values for the data path options.

', 'PivotTableFieldCollapseStateTarget$FieldDataPathValues' => '

The data path of the pivot table\'s header. Used to set the collapse state.

', ], ], 'DataPointDrillUpDownOption' => [ 'base' => '

The drill down options for data points in a dashbaord.

', 'refs' => [ 'DashboardPublishOptions$DataPointDrillUpDownOption' => '

The drill-down options of data points in a dashboard.

', ], ], 'DataPointMenuLabelOption' => [ 'base' => '

The data point menu options of a dashboard.

', 'refs' => [ 'DashboardPublishOptions$DataPointMenuLabelOption' => '

The data point menu label options of a dashboard.

', ], ], 'DataPointTooltipOption' => [ 'base' => '

The data point tooltip options.

', 'refs' => [ 'DashboardPublishOptions$DataPointTooltipOption' => '

The data point tool tip options of a dashboard.

', ], ], 'DataSet' => [ 'base' => '

Dataset.

', 'refs' => [ 'DescribeDataSetResponse$DataSet' => '

Information on the dataset.

', ], ], 'DataSetArnsList' => [ 'base' => NULL, 'refs' => [ 'Analysis$DataSetArns' => '

The ARNs of the datasets of the analysis.

', 'DashboardVersion$DataSetArns' => '

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

', ], ], 'DataSetConfiguration' => [ 'base' => '

Dataset configuration.

', 'refs' => [ 'DataSetConfigurationList$member' => NULL, ], ], 'DataSetConfigurationList' => [ 'base' => NULL, 'refs' => [ 'TemplateVersion$DataSetConfigurations' => '

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

', 'TemplateVersionDefinition$DataSetConfigurations' => '

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

', ], ], 'DataSetFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DataSetSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DataSetIdentifier' => [ 'base' => NULL, 'refs' => [ 'CalculatedField$DataSetIdentifier' => '

The data set that is used in this calculated field.

', 'ColumnIdentifier$DataSetIdentifier' => '

The data set that the column belongs to.

', 'CustomContentVisual$DataSetIdentifier' => '

The dataset that is used to create the custom content visual. You can\'t create a visual without a dataset.

', 'DataSetIdentifierDeclaration$Identifier' => '

The identifier of the data set, typically the data set\'s name.

', 'EmptyVisual$DataSetIdentifier' => '

The data set that is used in the empty visual. Every visual requires a dataset to render.

', 'InsightVisual$DataSetIdentifier' => '

The dataset that is used in the insight visual.

', 'MappedDataSetParameter$DataSetIdentifier' => '

A unique name that identifies a dataset within the analysis or dashboard.

', 'RollingDateConfiguration$DataSetIdentifier' => '

The data set that is used in the rolling date configuration.

', ], ], 'DataSetIdentifierDeclaration' => [ 'base' => '

A data set.

', 'refs' => [ 'DataSetIdentifierDeclarationList$member' => NULL, ], ], 'DataSetIdentifierDeclarationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$DataSetIdentifierDeclarations' => '

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

', 'DashboardVersionDefinition$DataSetIdentifierDeclarations' => '

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard\'s sub-structures.

', ], ], 'DataSetImportMode' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ImportMode' => '

Indicates whether you want to import the data into SPICE.

', 'DataSet$ImportMode' => '

A value that indicates whether you want to import the data into SPICE.

', 'DataSetSummary$ImportMode' => '

A value that indicates whether you want to import the data into SPICE.

', 'UpdateDataSetRequest$ImportMode' => '

Indicates whether you want to import the data into SPICE.

', ], ], 'DataSetName' => [ 'base' => NULL, 'refs' => [ 'AwsIotAnalyticsParameters$DataSetName' => '

Dataset name.

', ], ], 'DataSetReference' => [ 'base' => '

Dataset reference.

', 'refs' => [ 'DataSetReferenceList$member' => NULL, ], ], 'DataSetReferenceList' => [ 'base' => NULL, 'refs' => [ 'AnalysisSourceTemplate$DataSetReferences' => '

The dataset references of the source template of an analysis.

', 'DashboardSourceTemplate$DataSetReferences' => '

Dataset references.

', 'TemplateSourceAnalysis$DataSetReferences' => '

A structure containing information about the dataset references used as placeholders in the template.

', ], ], 'DataSetRefreshProperties' => [ 'base' => '

The refresh properties of a dataset.

', 'refs' => [ 'DescribeDataSetRefreshPropertiesResponse$DataSetRefreshProperties' => '

The dataset refresh properties.

', 'PutDataSetRefreshPropertiesRequest$DataSetRefreshProperties' => '

The dataset refresh properties.

', ], ], 'DataSetRegion' => [ 'base' => NULL, 'refs' => [ 'BigQueryParameters$DataSetRegion' => '

The storage location where you create a Google BigQuery data source.

', ], ], 'DataSetSchema' => [ 'base' => '

Dataset schema.

', 'refs' => [ 'DataSetConfiguration$DataSetSchema' => '

Dataset schema.

', ], ], 'DataSetSearchFilter' => [ 'base' => '

A filter that you apply when searching for datasets.

', 'refs' => [ 'DataSetSearchFilterList$member' => NULL, ], ], 'DataSetSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSetsRequest$Filters' => '

The filters to apply to the search.

', ], ], 'DataSetSummary' => [ 'base' => '

Dataset summary.

', 'refs' => [ 'DataSetSummaryList$member' => NULL, ], ], 'DataSetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataSetsResponse$DataSetSummaries' => '

The list of dataset summaries.

', 'SearchDataSetsResponse$DataSetSummaries' => '

A DataSetSummaries object that returns a summary of a dataset.

', ], ], 'DataSetUsageConfiguration' => [ 'base' => '

The usage configuration to apply to child datasets that reference this dataset as a source.

', 'refs' => [ 'CreateDataSetRequest$DataSetUsageConfiguration' => NULL, 'DataSet$DataSetUsageConfiguration' => '

The usage configuration to apply to child datasets that reference this dataset as a source.

', 'UpdateDataSetRequest$DataSetUsageConfiguration' => NULL, ], ], 'DataSource' => [ 'base' => '

The structure of a data source.

', 'refs' => [ 'DataSourceList$member' => NULL, 'DescribeDataSourceResponse$DataSource' => '

The information on the data source.

', ], ], 'DataSourceCredentials' => [ 'base' => '

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'CreateDataSourceRequest$Credentials' => '

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

', 'UpdateDataSourceRequest$Credentials' => '

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

', ], ], 'DataSourceErrorInfo' => [ 'base' => '

Error information for the data source creation or update.

', 'refs' => [ 'DataSource$ErrorInfo' => '

Error information from the last update or the creation of the data source.

', ], ], 'DataSourceErrorInfoType' => [ 'base' => NULL, 'refs' => [ 'DataSourceErrorInfo$Type' => '

Error type.

', ], ], 'DataSourceFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DataSourceSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources.

', ], ], 'DataSourceParameters' => [ 'base' => '

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.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$DataSourceParameters' => NULL, 'CreateDataSourceRequest$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source.

', 'DataSource$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'DataSourceParametersList$member' => NULL, 'UpdateDataSourceRequest$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source.

', ], ], 'DataSourceParametersList' => [ 'base' => NULL, 'refs' => [ 'CredentialPair$AlternateDataSourceParameters' => '

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that\'s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

', 'DataSource$AlternateDataSourceParameters' => '

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that\'s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

', ], ], 'DataSourceSearchFilter' => [ 'base' => '

A filter that you apply when searching for data sources.

', 'refs' => [ 'DataSourceSearchFilterList$member' => NULL, ], ], 'DataSourceSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSourcesRequest$Filters' => '

The filters to apply to the search.

', ], ], 'DataSourceSummary' => [ 'base' => '

A DataSourceSummary object that returns a summary of a data source.

', 'refs' => [ 'DataSourceSummaryList$member' => NULL, ], ], 'DataSourceSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSourcesResponse$DataSourceSummaries' => '

A DataSourceSummaries object that returns a summary of a data source.

', ], ], 'DataSourceType' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$Type' => '

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

', 'DataSource$Type' => '

The type of the data source. This type indicates which database engine the data source connects to.

', 'DataSourceSummary$Type' => '

The type of the data source.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Database' => '

Database.

', 'AuroraPostgreSqlParameters$Database' => '

The Amazon Aurora PostgreSQL database to connect to.

', 'MariaDbParameters$Database' => '

Database.

', 'MySqlParameters$Database' => '

Database.

', 'OracleParameters$Database' => '

The database.

', 'PostgreSqlParameters$Database' => '

Database.

', 'RdsParameters$Database' => '

Database.

', 'RedshiftParameters$Database' => '

Database.

', 'SnowflakeParameters$Database' => '

Database.

', 'SqlServerParameters$Database' => '

Database.

', 'TeradataParameters$Database' => '

Database.

', ], ], 'DatabaseGroup' => [ 'base' => NULL, 'refs' => [ 'DatabaseGroupList$member' => NULL, ], ], 'DatabaseGroupList' => [ 'base' => NULL, 'refs' => [ 'RedshiftIAMParameters$DatabaseGroups' => '

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.

', ], ], 'DatabaseUser' => [ 'base' => NULL, 'refs' => [ 'RedshiftIAMParameters$DatabaseUser' => '

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.

', ], ], 'DatabricksParameters' => [ 'base' => '

The parameters that are required to connect to a Databricks data source.

', 'refs' => [ 'DataSourceParameters$DatabricksParameters' => '

The parameters that are required to connect to a Databricks data source.

', ], ], 'DatasetMetadata' => [ 'base' => '

A structure that represents a dataset.

', 'refs' => [ 'Datasets$member' => NULL, ], ], 'DatasetParameter' => [ 'base' => '

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

', 'refs' => [ 'DatasetParameterList$member' => NULL, ], ], 'DatasetParameterId' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameter$Id' => '

An identifier for the parameter that is created in the dataset.

', 'DecimalDatasetParameter$Id' => '

An identifier for the decimal parameter created in the dataset.

', 'IntegerDatasetParameter$Id' => '

An identifier for the integer parameter created in the dataset.

', 'StringDatasetParameter$Id' => '

An identifier for the string parameter that is created in the dataset.

', ], ], 'DatasetParameterList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$DatasetParameters' => '

The parameter declarations of the dataset.

', 'DataSet$DatasetParameters' => '

The parameters that are declared in a dataset.

', 'UpdateDataSetRequest$DatasetParameters' => '

The parameter declarations of the dataset.

', ], ], 'DatasetParameterName' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameter$Name' => '

The name of the date time parameter that is created in the dataset.

', 'DecimalDatasetParameter$Name' => '

The name of the decimal parameter that is created in the dataset.

', 'IntegerDatasetParameter$Name' => '

The name of the integer parameter that is created in the dataset.

', 'OverrideDatasetParameterOperation$ParameterName' => '

The name of the parameter to be overridden with different values.

', 'OverrideDatasetParameterOperation$NewParameterName' => '

The new name for the parameter.

', 'StringDatasetParameter$Name' => '

The name of the string parameter that is created in the dataset.

', ], ], 'DatasetParameterValueType' => [ 'base' => '

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

', 'refs' => [ 'DateTimeDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'DecimalDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'IntegerDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'StringDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', ], ], 'Datasets' => [ 'base' => NULL, 'refs' => [ 'TopicDetails$DataSets' => '

The data sets that the topic is associated with.

', ], ], 'DateAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AggregationFunction$DateAggregationFunction' => '

Aggregation for date values.

', 'DateMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', ], ], 'DateAxisOptions' => [ 'base' => '

The options that determine how a date axis is displayed.

', 'refs' => [ 'AxisDataOptions$DateAxisOptions' => '

The options for an axis with a date field.

', ], ], 'DateDimensionField' => [ 'base' => '

The dimension type field with date type columns.

', 'refs' => [ 'DimensionField$DateDimensionField' => '

The dimension type field with date type columns.

', ], ], 'DateMeasureField' => [ 'base' => '

The measure type field with date type columns.

', 'refs' => [ 'MeasureField$DateMeasureField' => '

The measure type field with date type columns.

', ], ], 'DateTimeDatasetParameter' => [ 'base' => '

A date time parameter for a dataset.

', 'refs' => [ 'DatasetParameter$DateTimeDatasetParameter' => '

A date time parameter that is created in the dataset.

', ], ], 'DateTimeDatasetParameterDefaultValue' => [ 'base' => '

The default value for the date time parameter.

', 'refs' => [ 'DateTimeDatasetParameterValueList$member' => NULL, ], ], 'DateTimeDatasetParameterDefaultValues' => [ 'base' => '

The default values of a date time parameter.

', 'refs' => [ 'DateTimeDatasetParameter$DefaultValues' => '

A list of default values for a given date time parameter. This structure only accepts static values.

', ], ], 'DateTimeDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given date time parameter.

', 'NewDefaultValues$DateTimeStaticValues' => '

A list of static default values for a given date time parameter.

', ], ], 'DateTimeDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$DateTimeValues' => '

A list of datetime-type parameter values.

', 'DateTimeDefaultValues$StaticValues' => '

The static values of the DataTimeDefaultValues.

', ], ], 'DateTimeDefaultValues' => [ 'base' => '

The default values of the DateTimeParameterDeclaration.

', 'refs' => [ 'DateTimeParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'DateTimeFormat' => [ 'base' => NULL, 'refs' => [ 'DateTimeFormatConfiguration$DateTimeFormat' => '

Determines the DateTime format.

', 'DateTimePickerControlDisplayOptions$DateTimeFormat' => '

Customize how dates are formatted in controls.

', 'RelativeDateTimeControlDisplayOptions$DateTimeFormat' => '

Customize how dates are formatted in controls.

', ], ], 'DateTimeFormatConfiguration' => [ 'base' => '

Formatting configuration for DateTime fields.

', 'refs' => [ 'DateDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'DateMeasureField$FormatConfiguration' => '

The format configuration of the field.

', 'FormatConfiguration$DateTimeFormatConfiguration' => '

Formatting configuration for DateTime fields.

', ], ], 'DateTimeHierarchy' => [ 'base' => '

The option that determines the hierarchy of any DateTime fields.

', 'refs' => [ 'ColumnHierarchy$DateTimeHierarchy' => '

The option that determines the hierarchy of any DateTime fields.

', ], ], 'DateTimeParameter' => [ 'base' => '

A date-time parameter.

', 'refs' => [ 'DateTimeParameterList$member' => NULL, ], ], 'DateTimeParameterDeclaration' => [ 'base' => '

A parameter declaration for the DateTime data type.

', 'refs' => [ 'ParameterDeclaration$DateTimeParameterDeclaration' => '

A parameter declaration for the DateTime data type.

', ], ], 'DateTimeParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$DateTimeParameters' => '

The parameters that have a data type of date-time.

', ], ], 'DateTimePickerControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultDateTimePickerControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterDateTimePickerControl$DisplayOptions' => '

The display options of a control.

', 'ParameterDateTimePickerControl$DisplayOptions' => '

The display options of a control.

', ], ], 'DateTimeValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a DateTime parameter when a value has not been set.

', 'refs' => [ 'DateTimeParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a DateTime parameter when a value has not been set.

', ], ], 'DayOfMonth' => [ 'base' => NULL, 'refs' => [ 'ScheduleRefreshOnEntity$DayOfMonth' => '

The day of the month that you want to schedule refresh on.

', ], ], 'DayOfTheWeek' => [ 'base' => NULL, 'refs' => [ 'AssetOptions$WeekStart' => '

Determines the week start day for an analysis.

', ], ], 'DayOfWeek' => [ 'base' => NULL, 'refs' => [ 'ScheduleRefreshOnEntity$DayOfWeek' => '

The day of the week that you want to schedule a refresh on.

', ], ], 'DbUsername' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentialPair$Username' => '

The username for the data source connection.

', 'CredentialPair$Username' => '

User name.

', ], ], 'DecimalDatasetParameter' => [ 'base' => '

A decimal parameter for a dataset.

', 'refs' => [ 'DatasetParameter$DecimalDatasetParameter' => '

A decimal parameter that is created in the dataset.

', ], ], 'DecimalDatasetParameterDefaultValue' => [ 'base' => '

The default value for the decimal parameter.

', 'refs' => [ 'DecimalDatasetParameterValueList$member' => NULL, ], ], 'DecimalDatasetParameterDefaultValues' => [ 'base' => '

The default values of a decimal parameter.

', 'refs' => [ 'DecimalDatasetParameter$DefaultValues' => '

A list of default values for a given decimal parameter. This structure only accepts static values.

', ], ], 'DecimalDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'DecimalDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given decimal parameter.

', 'NewDefaultValues$DecimalStaticValues' => '

A list of static default values for a given decimal parameter.

', ], ], 'DecimalDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$DecimalValues' => '

A list of decimal-type parameter values.

', 'DecimalDefaultValues$StaticValues' => '

The static values of the DecimalDefaultValues.

', ], ], 'DecimalDefaultValues' => [ 'base' => '

The default values of the DecimalParameterDeclaration.

', 'refs' => [ 'DecimalParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'DecimalParameter' => [ 'base' => '

A decimal parameter.

', 'refs' => [ 'DecimalParameterList$member' => NULL, ], ], 'DecimalParameterDeclaration' => [ 'base' => '

A parameter declaration for the Decimal data type.

', 'refs' => [ 'ParameterDeclaration$DecimalParameterDeclaration' => '

A parameter declaration for the Decimal data type.

', ], ], 'DecimalParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$DecimalParameters' => '

The parameters that have a data type of decimal.

', ], ], 'DecimalPlaces' => [ 'base' => NULL, 'refs' => [ 'DecimalPlacesConfiguration$DecimalPlaces' => '

The values of the decimal places.

', ], ], 'DecimalPlacesConfiguration' => [ 'base' => '

The option that determines the decimal places configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', 'NumberDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', 'PercentageDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', ], ], 'DecimalValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a Decimal parameter when a value has not been set.

', 'refs' => [ 'DecimalParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a Decimal parameter when a value has not been set.

', ], ], 'DefaultAggregation' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$Aggregation' => '

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

', 'TopicColumn$Aggregation' => '

The type of aggregation that is performed on the column data when it\'s queried.

', ], ], 'DefaultDateTimePickerControlOptions' => [ 'base' => '

The default options that correspond to the filter control type of a DateTimePicker.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultDateTimePickerOptions' => '

The default options that correspond to the filter control type of a DateTimePicker.

', ], ], 'DefaultFilterControlConfiguration' => [ 'base' => '

The default configuration for all dependent controls of the filter.

', 'refs' => [ 'CategoryFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'CategoryInnerFilter$DefaultFilterControlConfiguration' => NULL, 'NumericEqualityFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'NumericRangeFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'RelativeDatesFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TimeEqualityFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TimeRangeFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TopBottomFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', ], ], 'DefaultFilterControlOptions' => [ 'base' => '

The option that corresponds to the control type of the filter.

', 'refs' => [ 'DefaultFilterControlConfiguration$ControlOptions' => '

The control option for the DefaultFilterControlConfiguration.

', ], ], 'DefaultFilterDropDownControlOptions' => [ 'base' => '

The default options that correspond to the Dropdown filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultDropdownOptions' => '

The default options that correspond to the Dropdown filter control type.

', ], ], 'DefaultFilterListControlOptions' => [ 'base' => '

The default options that correspond to the List filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultListOptions' => '

The default options that correspond to the List filter control type.

', ], ], 'DefaultFormatting' => [ 'base' => '

A structure that represents a default formatting definition.

', 'refs' => [ 'TopicCalculatedField$DefaultFormatting' => '

The default formatting definition.

', 'TopicColumn$DefaultFormatting' => '

The default formatting used for values in the column.

', ], ], 'DefaultFreeFormLayoutConfiguration' => [ 'base' => '

The options that determine the default settings of a free-form layout configuration.

', 'refs' => [ 'DefaultInteractiveLayoutConfiguration$FreeForm' => '

The options that determine the default settings of a free-form layout configuration.

', ], ], 'DefaultGridLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a grid layout configuration.

', 'refs' => [ 'DefaultInteractiveLayoutConfiguration$Grid' => '

The options that determine the default settings for a grid layout configuration.

', ], ], 'DefaultInteractiveLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for interactive layout configuration.

', 'refs' => [ 'DefaultNewSheetConfiguration$InteractiveLayoutConfiguration' => '

The options that determine the default settings for interactive layout configuration.

', ], ], 'DefaultNewSheetConfiguration' => [ 'base' => '

The configuration for default new sheet settings.

', 'refs' => [ 'AnalysisDefaults$DefaultNewSheetConfiguration' => '

The configuration for default new sheet settings.

', ], ], 'DefaultPaginatedLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a paginated layout configuration.

', 'refs' => [ 'DefaultNewSheetConfiguration$PaginatedLayoutConfiguration' => '

The options that determine the default settings for a paginated layout configuration.

', ], ], 'DefaultRelativeDateTimeControlOptions' => [ 'base' => '

The default options that correspond to the RelativeDateTime filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultRelativeDateTimeOptions' => '

The default options that correspond to the RelativeDateTime filter control type.

', ], ], 'DefaultSectionBasedLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a section-based layout configuration.

', 'refs' => [ 'DefaultPaginatedLayoutConfiguration$SectionBased' => '

The options that determine the default settings for a section-based layout configuration.

', ], ], 'DefaultSliderControlOptions' => [ 'base' => '

The default options that correspond to the Slider filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultSliderOptions' => '

The default options that correspond to the Slider filter control type.

', ], ], 'DefaultTextAreaControlOptions' => [ 'base' => '

The default options that correspond to the TextArea filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultTextAreaOptions' => '

The default options that correspond to the TextArea filter control type.

', ], ], 'DefaultTextFieldControlOptions' => [ 'base' => '

The default options that correspond to the TextField filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultTextFieldOptions' => '

The default options that correspond to the TextField filter control type.

', ], ], 'DeleteAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityPropagationConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityPropagationConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserByPrincipalIdRequest' => [ 'base' => '

', 'refs' => [], ], 'DeleteUserByPrincipalIdResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Delimiter' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$Delimiter' => '

The delimiter between values in the file.

', ], ], 'DescribeAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourcePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourcePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResolvedPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResolvedPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIpRestrictionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIpRestrictionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeyRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeyRegistrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplatePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplatePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationParameterValueConfiguration' => [ 'base' => '

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'SetParameterValueConfiguration$Value' => NULL, ], ], 'DimensionField' => [ 'base' => '

The dimension type field.

', 'refs' => [ 'BoxPlotDimensionFieldList$member' => NULL, 'DimensionFieldList$member' => NULL, 'FilledMapDimensionFieldList$member' => NULL, 'ForecastComputation$Time' => '

The time field that is used in a computation.

', 'FunnelChartDimensionFieldList$member' => NULL, 'GrowthRateComputation$Time' => '

The time field that is used in a computation.

', 'HeatMapDimensionFieldList$member' => NULL, 'MaximumMinimumComputation$Time' => '

The time field that is used in a computation.

', 'MetricComparisonComputation$Time' => '

The time field that is used in a computation.

', 'PeriodOverPeriodComputation$Time' => '

The time field that is used in a computation.

', 'PeriodToDateComputation$Time' => '

The time field that is used in a computation.

', 'PivotTableDimensionList$member' => NULL, 'RadarChartCategoryFieldList$member' => NULL, 'RadarChartColorFieldList$member' => NULL, 'SmallMultiplesDimensionFieldList$member' => NULL, 'TopBottomMoversComputation$Time' => '

The time field that is used in a computation.

', 'TopBottomMoversComputation$Category' => '

The category field that is used in a computation.

', 'TopBottomRankedComputation$Category' => '

The category field that is used in a computation.

', 'TreeMapDimensionFieldList$member' => NULL, 'UniqueValuesComputation$Category' => '

The category field that is used in a computation.

', 'WordCloudDimensionFieldList$member' => NULL, ], ], 'DimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$Category' => '

The category (y-axis) field well of a bar chart.

', 'BarChartAggregatedFieldWells$Colors' => '

The color (group/color) field well of a bar chart.

', 'ComboChartAggregatedFieldWells$Category' => '

The aggregated category field wells of a combo chart.

', 'ComboChartAggregatedFieldWells$Colors' => '

The aggregated colors field well of a combo chart.

', 'GeospatialMapAggregatedFieldWells$Geospatial' => '

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

', 'GeospatialMapAggregatedFieldWells$Colors' => '

The color field wells of a geospatial map.

', 'KPIFieldWells$TrendGroups' => '

The trend group field wells of a KPI visual.

', 'LineChartAggregatedFieldWells$Category' => '

The category field wells of a line chart. Values are grouped by category fields.

', 'LineChartAggregatedFieldWells$Colors' => '

The color field wells of a line chart. Values are grouped by category fields.

', 'PieChartAggregatedFieldWells$Category' => '

The category (group/color) field wells of a pie chart.

', 'SankeyDiagramAggregatedFieldWells$Source' => '

The source field wells of a sankey diagram.

', 'SankeyDiagramAggregatedFieldWells$Destination' => '

The destination field wells of a sankey diagram.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Category' => '

The category field well of a scatter plot.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Label' => '

The label field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$XAxis' => '

The x-axis field well of a scatter plot.

The x-axis is a dimension field and cannot be aggregated.

', 'ScatterPlotUnaggregatedFieldWells$YAxis' => '

The y-axis field well of a scatter plot.

The y-axis is a dimension field and cannot be aggregated.

', 'ScatterPlotUnaggregatedFieldWells$Category' => '

The category field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$Label' => '

The label field well of a scatter plot.

', 'TableAggregatedFieldWells$GroupBy' => '

The group by field well for a pivot table. Values are grouped by group by fields.

', 'WaterfallChartAggregatedFieldWells$Categories' => '

The category field wells of a waterfall visual.

', 'WaterfallChartAggregatedFieldWells$Breakdowns' => '

The breakdown field wells of a waterfall visual.

', ], ], 'DisplayFormat' => [ 'base' => NULL, 'refs' => [ 'DefaultFormatting$DisplayFormat' => '

The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.

', 'TopicIRGroupBy$DisplayFormat' => '

The display format for the TopicIRGroupBy.

', 'TopicIRMetric$DisplayFormat' => '

The display format for the TopicIRMetric.

', ], ], 'DisplayFormatOptions' => [ 'base' => '

A structure that represents additional options for display formatting.

', 'refs' => [ 'DefaultFormatting$DisplayFormatOptions' => '

The additional options for display formatting.

', 'TopicIRGroupBy$DisplayFormatOptions' => NULL, 'TopicIRMetric$DisplayFormatOptions' => NULL, ], ], 'DnsResolverList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$DnsResolvers' => '

An optional override of DNS resolvers to be used by the VPC connection.

', 'CreateVPCConnectionRequest$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', 'UpdateVPCConnectionRequest$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'AmazonElasticsearchParameters$Domain' => '

The OpenSearch domain.

', 'AmazonOpenSearchParameters$Domain' => '

The OpenSearch domain.

', ], ], 'DomainNotWhitelistedException' => [ 'base' => '

The domain specified isn\'t on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.

', 'refs' => [], ], 'DonutCenterOptions' => [ 'base' => '

The label options of the label that is displayed in the center of a donut chart. This option isn\'t available for pie charts.

', 'refs' => [ 'DonutOptions$DonutCenterOptions' => '

The label options of the label that is displayed in the center of a donut chart. This option isn\'t available for pie charts.

', ], ], 'DonutOptions' => [ 'base' => '

The options for configuring a donut chart or pie chart.

', 'refs' => [ 'PieChartConfiguration$DonutOptions' => '

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'ArcAxisDisplayRange$Min' => '

The minimum value of the arc axis range.

', 'ArcAxisDisplayRange$Max' => '

The maximum value of the arc axis range.

', 'ArcConfiguration$ArcAngle' => '

The option that determines the arc angle of a GaugeChartVisual.

', 'AxisDisplayMinMaxRange$Minimum' => '

The minimum setup for an axis display range.

', 'AxisDisplayMinMaxRange$Maximum' => '

The maximum setup for an axis display range.

', 'AxisLinearScale$StepSize' => '

The step size setup of a linear axis.

', 'AxisLogarithmicScale$Base' => '

The base setup of a logarithmic axis scale.

', 'AxisTickLabelOptions$RotationAngle' => '

The rotation angle of the axis tick labels.

', 'DataColor$DataValue' => '

The data value that the color is applied to.

', 'DefaultSliderControlOptions$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'DefaultSliderControlOptions$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'DefaultSliderControlOptions$StepSize' => '

The number of increments that the slider bar is divided into.

', 'FilterSliderControl$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'FilterSliderControl$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'FilterSliderControl$StepSize' => '

The number of increments that the slider bar is divided into.

', 'ForecastComputation$UpperBoundary' => '

The upper boundary setup of a forecast computation.

', 'ForecastComputation$LowerBoundary' => '

The lower boundary setup of a forecast computation.

', 'GradientStop$GradientOffset' => '

Determines gradient offset value.

', 'GradientStop$DataValue' => '

Determines the data value.

', 'HistogramBinOptions$StartValue' => '

The options that determine the bin start value.

', 'NumericEqualityDrillDownFilter$Value' => '

The value of the double input numeric drill down filter.

', 'NumericEqualityFilter$Value' => '

The input value.

', 'NumericRangeFilterValue$StaticValue' => '

The static value of the numeric range filter.

', 'ParameterSliderControl$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'ParameterSliderControl$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'ParameterSliderControl$StepSize' => '

The number of increments that the slider bar is divided into.

', 'TimeBasedForecastProperties$UpperBoundary' => '

The upper boundary setup of a forecast computation.

', 'TimeBasedForecastProperties$LowerBoundary' => '

The lower boundary setup of a forecast computation.

', 'WhatIfPointScenario$Value' => '

The target value that you want to meet for the provided date.

', 'WhatIfRangeScenario$Value' => '

The target value that you want to meet for the provided date range.

', ], ], 'DrillDownFilter' => [ 'base' => '

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DrillDownFilterList$member' => NULL, ], ], 'DrillDownFilterList' => [ 'base' => NULL, 'refs' => [ 'DateTimeHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the DateTime hierarchy.

', 'ExplicitHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the explicit hierarchy.

', 'PredefinedHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the predefined hierarchy.

', ], ], 'DropDownControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultFilterDropDownControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterDropDownControl$DisplayOptions' => '

The display options of the FilterDropDownControl.

', 'ParameterDropDownControl$DisplayOptions' => '

The display options of a control.

', ], ], 'DynamicDefaultValue' => [ 'base' => '

Defines different defaults to the users or groups based on mapping.

', 'refs' => [ 'DateTimeDefaultValues$DynamicValue' => '

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'DecimalDefaultValues$DynamicValue' => '

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'IntegerDefaultValues$DynamicValue' => '

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'StringDefaultValues$DynamicValue' => '

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

', ], ], 'Edition' => [ 'base' => NULL, 'refs' => [ 'AccountInfo$Edition' => '

The edition of your Amazon QuickSight account.

', 'AccountSettings$Edition' => '

The edition of Amazon QuickSight that you\'re currently subscribed to: Enterprise edition or Standard edition.

', 'CreateAccountSubscriptionRequest$Edition' => '

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:

', ], ], 'EmbeddingIdentityType' => [ 'base' => NULL, 'refs' => [ 'GetDashboardEmbedUrlRequest$IdentityType' => '

The authentication method that the user uses to sign in.

', ], ], 'EmbeddingUrl' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserResponse$EmbedUrl' => '

The embed URL for the dashboard.

', 'GenerateEmbedUrlForRegisteredUserResponse$EmbedUrl' => '

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

', 'GetDashboardEmbedUrlResponse$EmbedUrl' => '

A single-use URL that you can put into your server-side webpage to embed your dashboard. 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.

', 'GetSessionEmbedUrlResponse$EmbedUrl' => '

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.

', ], ], 'EmptyVisual' => [ 'base' => '

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.

', 'refs' => [ 'Visual$EmptyVisual' => '

An empty visual.

', ], ], 'Entity' => [ 'base' => '

An object, structure, or sub-structure of an analysis, template, or dashboard.

', 'refs' => [ 'EntityList$member' => NULL, ], ], 'EntityList' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$ViolatedEntities' => '

Lists the violated entities that caused the analysis error

', 'DashboardError$ViolatedEntities' => '

Lists the violated entities that caused the dashboard error.

', 'TemplateError$ViolatedEntities' => '

An error path that shows which entities caused the template error.

', ], ], 'EntryPath' => [ 'base' => NULL, 'refs' => [ 'RegisteredUserQuickSightConsoleEmbeddingConfiguration$InitialPath' => '

The initial URL path for the Amazon QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

', ], ], 'EntryPoint' => [ 'base' => NULL, 'refs' => [ 'GetSessionEmbedUrlRequest$EntryPoint' => '

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

', ], ], 'ErrorInfo' => [ 'base' => '

Error information for the SPICE ingestion of a dataset.

', 'refs' => [ 'Ingestion$ErrorInfo' => '

Error information for this ingestion.

', ], ], 'ExasolParameters' => [ 'base' => '

The required parameters for connecting to an Exasol data source.

', 'refs' => [ 'DataSourceParameters$ExasolParameters' => '

The parameters for Exasol.

', ], ], 'ExceptionResourceType' => [ 'base' => NULL, 'refs' => [ 'LimitExceededException$ResourceType' => '

Limit exceeded.

', 'ResourceExistsException$ResourceType' => '

The resource type for this request.

', 'ResourceNotFoundException$ResourceType' => '

The resource type for this request.

', 'ResourceUnavailableException$ResourceType' => '

The resource type for this request.

', ], ], 'ExcludePeriodConfiguration' => [ 'base' => '

The exclude period of TimeRangeFilter or RelativeDatesFilter.

', 'refs' => [ 'RelativeDatesFilter$ExcludePeriodConfiguration' => '

The configuration for the exclude period of the filter.

', 'TimeRangeFilter$ExcludePeriodConfiguration' => '

The exclude period of the time range filter.

', ], ], 'ExplicitHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields that are built within a visual\'s field wells. These fields can\'t be duplicated to other visuals.

', 'refs' => [ 'ColumnHierarchy$ExplicitHierarchy' => '

The option that determines the hierarchy of the fields that are built within a visual\'s field wells. These fields can\'t be duplicated to other visuals.

', ], ], 'ExplicitHierarchyColumnList' => [ 'base' => NULL, 'refs' => [ 'ExplicitHierarchy$Columns' => '

The list of columns that define the explicit hierarchy.

', ], ], 'ExportHiddenFieldsOption' => [ 'base' => '

Determines if hidden fields are included in an exported dashboard.

', 'refs' => [ 'DashboardVisualPublishOptions$ExportHiddenFieldsOption' => '

Determines if hidden fields are included in an exported dashboard.

', ], ], 'ExportToCSVOption' => [ 'base' => '

Export to .csv option.

', 'refs' => [ 'DashboardPublishOptions$ExportToCSVOption' => '

Export to .csv option.

', ], ], 'ExportWithHiddenFieldsOption' => [ 'base' => '

Determines whether or not hidden fields are visible on exported dashbaords.

', 'refs' => [ 'DashboardPublishOptions$ExportWithHiddenFieldsOption' => '

Determines if hidden fields are exported with a dashboard.

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$Expression' => '

An expression that defines the calculated column.

', 'CalculatedMeasureField$Expression' => '

The expression in the table calculation.

', 'ConditionalFormattingCustomIconCondition$Expression' => '

The expression that determines the condition of the icon set.

', 'ConditionalFormattingGradientColor$Expression' => '

The expression that determines the formatting configuration for gradient color.

', 'ConditionalFormattingIconSet$Expression' => '

The expression that determines the formatting configuration for the icon set.

', 'ConditionalFormattingSolidColor$Expression' => '

The expression that determines the formatting configuration for solid color.

', 'FilterOperation$ConditionExpression' => '

An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.

', 'RollingDateConfiguration$Expression' => '

The expression of the rolling date configuration.

', 'SheetElementRenderingRule$Expression' => '

The expression of the rendering rules of a sheet.

', 'TopicCalculatedField$Expression' => '

The calculated field expression.

', 'TopicIRMetric$Expression' => '

The expression for the TopicIRMetric.

', ], ], 'FailedKeyRegistrationEntries' => [ 'base' => NULL, 'refs' => [ 'UpdateKeyRegistrationResponse$FailedKeyRegistration' => '

A list of all customer managed key registrations that failed to update.

', ], ], 'FailedKeyRegistrationEntry' => [ 'base' => '

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

', 'refs' => [ 'FailedKeyRegistrationEntries$member' => NULL, ], ], 'FieldBasedTooltip' => [ 'base' => '

The setup for the detailed tooltip.

', 'refs' => [ 'TooltipOptions$FieldBasedTooltip' => '

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

', ], ], 'FieldFolder' => [ 'base' => '

A FieldFolder element is a folder that contains fields and nested subfolders.

', 'refs' => [ 'FieldFolderMap$value' => NULL, ], ], 'FieldFolderDescription' => [ 'base' => NULL, 'refs' => [ 'FieldFolder$description' => '

The description for a field folder.

', ], ], 'FieldFolderMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', 'DataSet$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', 'UpdateDataSetRequest$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', ], ], 'FieldFolderPath' => [ 'base' => NULL, 'refs' => [ 'FieldFolderMap$key' => NULL, ], ], 'FieldId' => [ 'base' => NULL, 'refs' => [ 'AxisLabelReferenceOptions$FieldId' => '

The field that the axis label is targeted to.

', 'CalculatedMeasureField$FieldId' => '

The custom field ID.

', 'CategoricalDimensionField$FieldId' => '

The custom field ID.

', 'CategoricalMeasureField$FieldId' => '

The custom field ID.

', 'ContributionAnalysisDefault$MeasureFieldId' => '

The measure field that is used in the contribution analysis.

', 'DataBarsOptions$FieldId' => '

The field ID for the data bars options.

', 'DataFieldSeriesItem$FieldId' => '

The field ID of the field that you are setting the axis binding to.

', 'DataPathLabelType$FieldId' => '

The field ID of the field that the data label needs to be applied to.

', 'DataPathValue$FieldId' => '

The field ID of the field that needs to be sorted.

', 'DateDimensionField$FieldId' => '

The custom field ID.

', 'DateMeasureField$FieldId' => '

The custom field ID.

', 'DestinationParameterValueConfiguration$SourceField' => '

The source field ID of the destination parameter.

', 'FieldLabelType$FieldId' => '

Indicates the field that is targeted by the field label.

', 'FieldOrderList$member' => NULL, 'FieldSeriesItem$FieldId' => '

The field ID of the field for which you are setting the axis binding.

', 'FieldSort$FieldId' => '

The sort configuration target field.

', 'FieldTooltipItem$FieldId' => '

The unique ID of the field that is targeted by the tooltip.

', 'FilledMapShapeConditionalFormatting$FieldId' => '

The field ID of the filled map shape.

', 'NumericalDimensionField$FieldId' => '

The custom field ID.

', 'NumericalMeasureField$FieldId' => '

The custom field ID.

', 'PivotFieldSortOptions$FieldId' => '

The field ID for the field sort options.

', 'PivotTableCellConditionalFormatting$FieldId' => '

The field ID of the cell for conditional formatting.

', 'PivotTableFieldOption$FieldId' => '

The field ID of the pivot table field.

', 'PivotTableFieldSubtotalOptions$FieldId' => '

The field ID of the subtotal options.

', 'SelectedFieldList$member' => NULL, 'TableCellConditionalFormatting$FieldId' => '

The field ID of the cell for conditional formatting.

', 'TableFieldOption$FieldId' => '

The field ID for a table field.

', 'TableFieldOrderList$member' => NULL, 'TotalAggregationOption$FieldId' => '

The field id that\'s associated with the total aggregation option.

', 'UnaggregatedField$FieldId' => '

The custom field ID.

', ], ], 'FieldLabelType' => [ 'base' => '

The field label type.

', 'refs' => [ 'DataLabelType$FieldLabelType' => '

Determines the label configuration for the entire field.

', ], ], 'FieldOrderList' => [ 'base' => NULL, 'refs' => [ 'TableFieldOptions$Order' => '

The order of the field IDs that are configured as field options for a table visual.

', ], ], 'FieldSeriesItem' => [ 'base' => '

The field series item configuration of a line chart.

', 'refs' => [ 'SeriesItem$FieldSeriesItem' => '

The field series item configuration of a line chart.

', ], ], 'FieldSort' => [ 'base' => '

The sort configuration for a field in a field well.

', 'refs' => [ 'FieldSortOptions$FieldSort' => '

The sort configuration for a field in a field well.

', 'PivotTableSortBy$Field' => '

The field sort (field id, direction) for the pivot table sort by options.

', ], ], 'FieldSortOptions' => [ 'base' => '

The field sort options in a chart configuration.

', 'refs' => [ 'FieldSortOptionsList$member' => NULL, 'RowSortList$member' => NULL, ], ], 'FieldSortOptionsList' => [ 'base' => NULL, 'refs' => [ 'BarChartSortConfiguration$CategorySort' => '

The sort configuration of category fields.

', 'BarChartSortConfiguration$ColorSort' => '

The sort configuration of color fields in a bar chart.

', 'BarChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'BoxPlotSortConfiguration$CategorySort' => '

The sort configuration of a group by fields.

', 'ComboChartSortConfiguration$CategorySort' => '

The sort configuration of the category field well in a combo chart.

', 'ComboChartSortConfiguration$ColorSort' => '

The sort configuration of the color field well in a combo chart.

', 'FilledMapSortConfiguration$CategorySort' => '

The sort configuration of the location fields.

', 'FunnelChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'HeatMapSortConfiguration$HeatMapRowSort' => '

The field sort configuration of the rows fields.

', 'HeatMapSortConfiguration$HeatMapColumnSort' => '

The column sort configuration for heat map for columns that aren\'t a part of a field well.

', 'KPISortConfiguration$TrendGroupSort' => '

The sort configuration of the trend group fields.

', 'LineChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'LineChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'PieChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'PieChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'RadarChartSortConfiguration$CategorySort' => '

The category sort options of a radar chart.

', 'RadarChartSortConfiguration$ColorSort' => '

The color sort configuration of a radar chart.

', 'SankeyDiagramSortConfiguration$WeightSort' => '

The sort configuration of the weight fields.

', 'TreeMapSortConfiguration$TreeMapSort' => '

The sort configuration of group by fields.

', 'WaterfallChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'WordCloudSortConfiguration$CategorySort' => '

The sort configuration of group by fields.

', ], ], 'FieldTooltipItem' => [ 'base' => '

The tooltip item for the fields.

', 'refs' => [ 'TooltipItem$FieldTooltipItem' => '

The tooltip item for the fields.

', ], ], 'FieldValue' => [ 'base' => NULL, 'refs' => [ 'CustomColor$FieldValue' => '

The data value that the color is applied to.

', 'DataPathLabelType$FieldValue' => '

The actual value of the field that is labeled.

', 'DataPathValue$FieldValue' => '

The actual value of the field that needs to be sorted.

', ], ], 'FileFormat' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$Format' => '

File format.

', ], ], 'FilledMapAggregatedFieldWells' => [ 'base' => '

The aggregated field well of the filled map.

', 'refs' => [ 'FilledMapFieldWells$FilledMapAggregatedFieldWells' => '

The aggregated field well of the filled map.

', ], ], 'FilledMapConditionalFormatting' => [ 'base' => '

The conditional formatting of a FilledMapVisual.

', 'refs' => [ 'FilledMapVisual$ConditionalFormatting' => '

The conditional formatting of a FilledMapVisual.

', ], ], 'FilledMapConditionalFormattingOption' => [ 'base' => '

Conditional formatting options of a FilledMapVisual.

', 'refs' => [ 'FilledMapConditionalFormattingOptionList$member' => NULL, ], ], 'FilledMapConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'FilledMapConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options of a FilledMapVisual.

', ], ], 'FilledMapConfiguration' => [ 'base' => '

The configuration for a FilledMapVisual.

', 'refs' => [ 'FilledMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'FilledMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'FilledMapAggregatedFieldWells$Geospatial' => '

The aggregated location field well of the filled map. Values are grouped by location fields.

', ], ], 'FilledMapFieldWells' => [ 'base' => '

The field wells of a FilledMapVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilledMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'FilledMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'FilledMapAggregatedFieldWells$Values' => '

The aggregated color field well of a filled map. Values are aggregated based on location fields.

', ], ], 'FilledMapShapeConditionalFormatting' => [ 'base' => '

The conditional formatting that determines the shape of the filled map.

', 'refs' => [ 'FilledMapConditionalFormattingOption$Shape' => '

The conditional formatting that determines the shape of the filled map.

', ], ], 'FilledMapSortConfiguration' => [ 'base' => '

The sort configuration of a FilledMapVisual.

', 'refs' => [ 'FilledMapConfiguration$SortConfiguration' => '

The sort configuration of a FilledMapVisual.

', ], ], 'FilledMapVisual' => [ 'base' => '

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$FilledMapVisual' => '

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

', ], ], 'Filter' => [ 'base' => '

With a Filter, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterAggMetrics' => [ 'base' => '

The definition for the FilterAggMetrics.

', 'refs' => [ 'FilterAggMetricsList$member' => NULL, ], ], 'FilterAggMetricsList' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$AggMetrics' => '

The agg metrics for the TopicIRFilterOption.

', ], ], 'FilterClass' => [ 'base' => NULL, 'refs' => [ 'TopicFilter$FilterClass' => '

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

', 'TopicIRFilterOption$FilterClass' => '

The filter class for the TopicIRFilterOption.

', ], ], 'FilterControl' => [ 'base' => '

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterControlList$member' => NULL, ], ], 'FilterControlList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$FilterControls' => '

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

', ], ], 'FilterCrossSheetControl' => [ 'base' => '

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

', 'refs' => [ 'FilterControl$CrossSheet' => '

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

', ], ], 'FilterDateTimePickerControl' => [ 'base' => '

A control from a date filter that is used to specify date and time.

', 'refs' => [ 'FilterControl$DateTimePicker' => '

A control from a date filter that is used to specify date and time.

', ], ], 'FilterDropDownControl' => [ 'base' => '

A control to display a dropdown list with buttons that are used to select a single value.

', 'refs' => [ 'FilterControl$Dropdown' => '

A control to display a dropdown list with buttons that are used to select a single value.

', ], ], 'FilterGroup' => [ 'base' => '

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

', 'refs' => [ 'FilterGroupList$member' => NULL, ], ], 'FilterGroupList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$FilterGroups' => '

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'DashboardVersionDefinition$FilterGroups' => '

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'TemplateVersionDefinition$FilterGroups' => '

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

', ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'FilterGroup$Filters' => '

The list of filters that are present in a FilterGroup.

', ], ], 'FilterListConfiguration' => [ 'base' => '

A list of filter configurations.

', 'refs' => [ 'CategoryFilterConfiguration$FilterListConfiguration' => '

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

', ], ], 'FilterListControl' => [ 'base' => '

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

', 'refs' => [ 'FilterControl$List' => '

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

', ], ], 'FilterNullOption' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'CustomFilterListConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'FilterListConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'NumericEqualityFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'NumericRangeFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'RelativeDatesFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'TimeRangeFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', ], ], 'FilterOperation' => [ 'base' => '

A transform operation that filters rows based on a condition.

', 'refs' => [ 'TransformOperation$FilterOperation' => '

An operation that filters rows based on some condition.

', ], ], 'FilterOperationSelectedFieldsConfiguration' => [ 'base' => '

The configuration of selected fields in theCustomActionFilterOperation.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomActionFilterOperation$SelectedFieldsConfiguration' => '

The configuration that chooses the fields to be filtered.

', ], ], 'FilterOperationTargetVisualsConfiguration' => [ 'base' => '

The configuration of target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomActionFilterOperation$TargetVisualsConfiguration' => '

The configuration that chooses the target visuals to be filtered.

', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'AnalysisSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

', 'DashboardSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

', 'DataSetSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

', 'DataSourceSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

', 'FolderSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

', ], ], 'FilterRelativeDateTimeControl' => [ 'base' => '

A control from a date filter that is used to specify the relative date.

', 'refs' => [ 'FilterControl$RelativeDateTime' => '

A control from a date filter that is used to specify the relative date.

', ], ], 'FilterScopeConfiguration' => [ 'base' => '

The scope configuration for a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterGroup$ScopeConfiguration' => '

The configuration that specifies what scope to apply to a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', ], ], 'FilterSelectableValues' => [ 'base' => '

A list of selectable values that are used in a control.

', 'refs' => [ 'DefaultFilterDropDownControlOptions$SelectableValues' => '

A list of selectable values that are used in a control.

', 'DefaultFilterListControlOptions$SelectableValues' => '

A list of selectable values that are used in a control.

', 'FilterDropDownControl$SelectableValues' => '

A list of selectable values that are used in a control.

', 'FilterListControl$SelectableValues' => '

A list of selectable values that are used in a control.

', ], ], 'FilterSliderControl' => [ 'base' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', 'refs' => [ 'FilterControl$Slider' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', ], ], 'FilterTextAreaControl' => [ 'base' => '

A control to display a text box that is used to enter multiple entries.

', 'refs' => [ 'FilterControl$TextArea' => '

A control to display a text box that is used to enter multiple entries.

', ], ], 'FilterTextFieldControl' => [ 'base' => '

A control to display a text box that is used to enter a single entry.

', 'refs' => [ 'FilterControl$TextField' => '

A control to display a text box that is used to enter a single entry.

', ], ], 'FilterVisualScope' => [ 'base' => NULL, 'refs' => [ 'SheetVisualScopingConfiguration$Scope' => '

The scope of the applied entities. Choose one of the following options:

', ], ], 'FilteredVisualsList' => [ 'base' => NULL, 'refs' => [ 'SheetVisualScopingConfiguration$VisualIds' => '

The selected visuals that the filter is applied to.

', ], ], 'Folder' => [ 'base' => '

A folder in Amazon QuickSight.

', 'refs' => [ 'DescribeFolderResponse$Folder' => '

Information about the folder.

', ], ], 'FolderArnList' => [ 'base' => NULL, 'refs' => [ 'CreateAnalysisRequest$FolderArns' => '

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

', 'CreateDashboardRequest$FolderArns' => '

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

', 'CreateDataSetRequest$FolderArns' => '

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

', 'CreateDataSourceRequest$FolderArns' => '

When you create the data source, Amazon QuickSight adds the data source to these folders.

', ], ], 'FolderColumnList' => [ 'base' => NULL, 'refs' => [ 'FieldFolder$columns' => '

A folder has a list of columns. A column can only be in one folder.

', ], ], 'FolderFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'FolderSearchFilter$Name' => '

The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'FolderMember' => [ 'base' => '

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

', 'refs' => [ 'CreateFolderMembershipResponse$FolderMember' => '

Information about the member in the folder.

', ], ], 'FolderMemberList' => [ 'base' => NULL, 'refs' => [ 'ListFolderMembersResponse$FolderMemberList' => '

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

', ], ], 'FolderName' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$Name' => '

The name of the folder.

', 'Folder$Name' => '

A display name for the folder.

', 'FolderSummary$Name' => '

The display name of the folder.

', 'UpdateFolderRequest$Name' => '

The name of the folder.

', ], ], 'FolderSearchFilter' => [ 'base' => '

A filter to use to search an Amazon QuickSight folder.

', 'refs' => [ 'FolderSearchFilterList$member' => NULL, ], ], 'FolderSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchFoldersRequest$Filters' => '

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

', ], ], 'FolderSummary' => [ 'base' => '

A summary of information about an existing Amazon QuickSight folder.

', 'refs' => [ 'FolderSummaryList$member' => NULL, ], ], 'FolderSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListFoldersResponse$FolderSummaryList' => '

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

', 'SearchFoldersResponse$FolderSummaryList' => '

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

', ], ], 'FolderType' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$FolderType' => '

The type of folder. By default, folderType is SHARED.

', 'Folder$FolderType' => '

The type of folder it is.

', 'FolderSummary$FolderType' => '

The type of folder.

', ], ], 'Font' => [ 'base' => '

Determines the font settings.

', 'refs' => [ 'FontList$member' => NULL, ], ], 'FontConfiguration' => [ 'base' => '

Configures the display properties of the given text.

', 'refs' => [ 'AxisLabelOptions$FontConfiguration' => '

The font configuration of the axis label.

', 'DataLabelOptions$LabelFontConfiguration' => '

Determines the font configuration of the data labels.

', 'FunnelChartDataLabelOptions$LabelFontConfiguration' => '

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

', 'GaugeChartOptions$PrimaryValueFontConfiguration' => '

The options that determine the primary value font configuration.

', 'KPIOptions$PrimaryValueFontConfiguration' => '

The options that determine the primary value font configuration.

', 'KPIOptions$SecondaryValueFontConfiguration' => '

The options that determine the secondary value font configuration.

', 'LabelOptions$FontConfiguration' => '

The font configuration of the label.

', 'PanelTitleOptions$FontConfiguration' => NULL, 'ReferenceLineLabelConfiguration$FontConfiguration' => '

The font configuration of the label in a reference line.

', 'TableCellStyle$FontConfiguration' => '

The font configuration of the table cells.

', 'TableFieldCustomTextContent$FontConfiguration' => '

The font configuration of the custom text content for the table URL link content.

', ], ], 'FontDecoration' => [ 'base' => NULL, 'refs' => [ 'FontConfiguration$FontDecoration' => '

Determines the appearance of decorative lines on the text.

', ], ], 'FontList' => [ 'base' => NULL, 'refs' => [ 'Typography$FontFamilies' => '

Determines the list of font families.

', ], ], 'FontSize' => [ 'base' => '

The option that determines the text display size.

', 'refs' => [ 'FontConfiguration$FontSize' => '

The option that determines the text display size.

', ], ], 'FontStyle' => [ 'base' => NULL, 'refs' => [ 'FontConfiguration$FontStyle' => '

Determines the text display face that is inherited by the given font family.

', ], ], 'FontWeight' => [ 'base' => '

The option that determines the text display weight, or boldness.

', 'refs' => [ 'FontConfiguration$FontWeight' => '

The option that determines the text display weight, or boldness.

', ], ], 'FontWeightName' => [ 'base' => NULL, 'refs' => [ 'FontWeight$Name' => '

The lexical name for the level of boldness of the text display.

', ], ], 'ForecastComputation' => [ 'base' => '

The forecast computation configuration.

', 'refs' => [ 'Computation$Forecast' => '

The forecast computation configuration.

', ], ], 'ForecastComputationCustomSeasonalityValue' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$CustomSeasonalityValue' => '

The custom seasonality value setup of a forecast computation.

', ], ], 'ForecastComputationSeasonality' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$Seasonality' => '

The seasonality setup of a forecast computation. Choose one of the following options:

', ], ], 'ForecastConfiguration' => [ 'base' => '

The forecast configuration that is used in a line chart\'s display properties.

', 'refs' => [ 'ForecastConfigurationList$member' => NULL, ], ], 'ForecastConfigurationList' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$ForecastConfigurations' => '

The forecast configuration of a line chart.

', ], ], 'ForecastScenario' => [ 'base' => '

The forecast scenario of a forecast in the line chart.

', 'refs' => [ 'ForecastConfiguration$Scenario' => '

The forecast scenario of a forecast in the line chart.

', ], ], 'FormatConfiguration' => [ 'base' => '

The formatting configuration for all types of field.

', 'refs' => [ 'ColumnConfiguration$FormatConfiguration' => '

The format configuration of a column.

', 'UnaggregatedField$FormatConfiguration' => '

The format configuration of the field.

', ], ], 'FreeFormLayoutCanvasSizeOptions' => [ 'base' => '

Configuration options for the canvas of a free-form layout.

', 'refs' => [ 'DefaultFreeFormLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a free-form layout.

', 'FreeFormLayoutConfiguration$CanvasSizeOptions' => NULL, ], ], 'FreeFormLayoutConfiguration' => [ 'base' => '

The configuration of a free-form layout.

', 'refs' => [ 'LayoutConfiguration$FreeFormLayout' => '

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

', ], ], 'FreeFormLayoutElement' => [ 'base' => '

An element within a free-form layout.

', 'refs' => [ 'FreeFromLayoutElementList$member' => NULL, ], ], 'FreeFormLayoutElementBackgroundStyle' => [ 'base' => '

The background style configuration of a free-form layout element.

', 'refs' => [ 'FreeFormLayoutElement$BackgroundStyle' => '

The background style configuration of a free-form layout element.

', ], ], 'FreeFormLayoutElementBorderStyle' => [ 'base' => '

The background style configuration of a free-form layout element.

', 'refs' => [ 'FreeFormLayoutElement$BorderStyle' => '

The border style configuration of a free-form layout element.

', 'FreeFormLayoutElement$SelectedBorderStyle' => '

The border style configuration of a free-form layout element. This border style is used when the element is selected.

', ], ], 'FreeFormLayoutScreenCanvasSizeOptions' => [ 'base' => '

The options that determine the sizing of the canvas used in a free-form layout.

', 'refs' => [ 'FreeFormLayoutCanvasSizeOptions$ScreenCanvasSizeOptions' => '

The options that determine the sizing of the canvas used in a free-form layout.

', ], ], 'FreeFormSectionLayoutConfiguration' => [ 'base' => '

The free-form layout configuration of a section.

', 'refs' => [ 'SectionLayoutConfiguration$FreeFormLayout' => '

The free-form layout configuration of a section.

', ], ], 'FreeFromLayoutElementList' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutConfiguration$Elements' => '

The elements that are included in a free-form layout.

', 'FreeFormSectionLayoutConfiguration$Elements' => '

The elements that are included in the free-form layout.

', ], ], 'FunnelChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartFieldWells$FunnelChartAggregatedFieldWells' => '

The field well configuration of a FunnelChartVisual.

', ], ], 'FunnelChartConfiguration' => [ 'base' => '

The configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartVisual$ChartConfiguration' => '

The configuration of a FunnelChartVisual.

', ], ], 'FunnelChartDataLabelOptions' => [ 'base' => '

The options that determine the presentation of the data labels.

', 'refs' => [ 'FunnelChartConfiguration$DataLabelOptions' => '

The options that determine the presentation of the data labels.

', ], ], 'FunnelChartDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'FunnelChartAggregatedFieldWells$Category' => '

The category field wells of a funnel chart. Values are grouped by category fields.

', ], ], 'FunnelChartFieldWells' => [ 'base' => '

The field well configuration of a FunnelChartVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FunnelChartConfiguration$FieldWells' => '

The field well configuration of a FunnelChartVisual.

', ], ], 'FunnelChartMeasureDataLabelStyle' => [ 'base' => NULL, 'refs' => [ 'FunnelChartDataLabelOptions$MeasureDataLabelStyle' => '

Determines the style of the metric labels.

', ], ], 'FunnelChartMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'FunnelChartAggregatedFieldWells$Values' => '

The value field wells of a funnel chart. Values are aggregated based on categories.

', ], ], 'FunnelChartSortConfiguration' => [ 'base' => '

The sort configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartConfiguration$SortConfiguration' => '

The sort configuration of a FunnelChartVisual.

', ], ], 'FunnelChartVisual' => [ 'base' => '

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$FunnelChartVisual' => '

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

', ], ], 'GaugeChartArcConditionalFormatting' => [ 'base' => '

The options that determine the presentation of the arc of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOption$Arc' => '

The options that determine the presentation of the arc of a GaugeChartVisual.

', ], ], 'GaugeChartColorConfiguration' => [ 'base' => '

The color configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$ColorConfiguration' => '

The color configuration of a GaugeChartVisual.

', ], ], 'GaugeChartConditionalFormatting' => [ 'base' => '

The conditional formatting of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartVisual$ConditionalFormatting' => '

The conditional formatting of a GaugeChartVisual.

', ], ], 'GaugeChartConditionalFormattingOption' => [ 'base' => '

Conditional formatting options of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOptionList$member' => NULL, ], ], 'GaugeChartConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'GaugeChartConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options of a GaugeChartVisual.

', ], ], 'GaugeChartConfiguration' => [ 'base' => '

The configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartVisual$ChartConfiguration' => '

The configuration of a GaugeChartVisual.

', ], ], 'GaugeChartFieldWells' => [ 'base' => '

The field well configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$FieldWells' => '

The field well configuration of a GaugeChartVisual.

', ], ], 'GaugeChartOptions' => [ 'base' => '

The options that determine the presentation of the GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$GaugeChartOptions' => '

The options that determine the presentation of the GaugeChartVisual.

', ], ], 'GaugeChartPrimaryValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the primary value of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOption$PrimaryValue' => '

The conditional formatting for the primary value of a GaugeChartVisual.

', ], ], 'GaugeChartVisual' => [ 'base' => '

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$GaugeChartVisual' => '

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

', ], ], 'GenerateEmbedUrlForAnonymousUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForAnonymousUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForRegisteredUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForRegisteredUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GeoSpatialColumnGroup' => [ 'base' => '

Geospatial column group that denotes a hierarchy.

', 'refs' => [ 'ColumnGroup$GeoSpatialColumnGroup' => '

Geospatial column group that denotes a hierarchy.

', ], ], 'GeoSpatialCountryCode' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$CountryCode' => '

Country code.

', ], ], 'GeoSpatialDataRole' => [ 'base' => NULL, 'refs' => [ 'ColumnTag$ColumnGeographicRole' => '

A geospatial role for a column.

', ], ], 'GeospatialCoordinateBounds' => [ 'base' => '

The bound options (north, south, west, east) of the geospatial window options.

', 'refs' => [ 'GeospatialWindowOptions$Bounds' => '

The bounds options (north, south, west, east) of the geospatial window options.

', ], ], 'GeospatialHeatmapColorScale' => [ 'base' => '

The color scale specification for the heatmap point style.

', 'refs' => [ 'GeospatialHeatmapConfiguration$HeatmapColor' => '

The color scale specification for the heatmap point style.

', ], ], 'GeospatialHeatmapConfiguration' => [ 'base' => '

The heatmap configuration of the geospatial point style.

', 'refs' => [ 'GeospatialPointStyleOptions$HeatmapConfiguration' => '

The heatmap configuration of the geospatial point style.

', ], ], 'GeospatialHeatmapDataColor' => [ 'base' => '

The color to be used in the heatmap point style.

', 'refs' => [ 'GeospatialHeatmapDataColorList$member' => NULL, ], ], 'GeospatialHeatmapDataColorList' => [ 'base' => NULL, 'refs' => [ 'GeospatialHeatmapColorScale$Colors' => '

The list of colors to be used in heatmap point style.

', ], ], 'GeospatialMapAggregatedFieldWells' => [ 'base' => '

The aggregated field wells for a geospatial map.

', 'refs' => [ 'GeospatialMapFieldWells$GeospatialMapAggregatedFieldWells' => '

The aggregated field well for a geospatial map.

', ], ], 'GeospatialMapConfiguration' => [ 'base' => '

The configuration of a GeospatialMapVisual.

', 'refs' => [ 'GeospatialMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'GeospatialMapFieldWells' => [ 'base' => '

The field wells of a GeospatialMapVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'GeospatialMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'GeospatialMapStyleOptions' => [ 'base' => '

The map style options of the geospatial map.

', 'refs' => [ 'FilledMapConfiguration$MapStyleOptions' => '

The map style options of the filled map visual.

', 'GeospatialMapConfiguration$MapStyleOptions' => '

The map style options of the geospatial map.

', ], ], 'GeospatialMapVisual' => [ 'base' => '

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$GeospatialMapVisual' => '

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

', ], ], 'GeospatialPointStyleOptions' => [ 'base' => '

The point style of the geospatial map.

', 'refs' => [ 'GeospatialMapConfiguration$PointStyleOptions' => '

The point style options of the geospatial map.

', ], ], 'GeospatialSelectedPointStyle' => [ 'base' => NULL, 'refs' => [ 'GeospatialPointStyleOptions$SelectedPointStyle' => '

The selected point styles (point, cluster) of the geospatial map.

', ], ], 'GeospatialWindowOptions' => [ 'base' => '

The window options of the geospatial map visual.

', 'refs' => [ 'FilledMapConfiguration$WindowOptions' => '

The window options of the filled map visual.

', 'GeospatialMapConfiguration$WindowOptions' => '

The window options of the geospatial map.

', ], ], 'GetDashboardEmbedUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDashboardEmbedUrlResponse' => [ 'base' => '

Output returned from the GetDashboardEmbedUrl operation.

', 'refs' => [], ], 'GetSessionEmbedUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionEmbedUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlobalTableBorderOptions' => [ 'base' => '

Determines the border options for a table visual.

', 'refs' => [ 'TableCellStyle$Border' => '

The borders for the table cells.

', ], ], 'GradientColor' => [ 'base' => '

Determines the gradient color settings.

', 'refs' => [ 'ConditionalFormattingGradientColor$Color' => '

Determines the color.

', ], ], 'GradientStop' => [ 'base' => '

Determines the gradient stop configuration.

', 'refs' => [ 'GradientStopList$member' => NULL, ], ], 'GradientStopList' => [ 'base' => NULL, 'refs' => [ 'GradientColor$Stops' => '

The list of gradient color stops.

', ], ], 'GridLayoutCanvasSizeOptions' => [ 'base' => '

Configuration options for the canvas of a grid layout.

', 'refs' => [ 'DefaultGridLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a grid layout.

', 'GridLayoutConfiguration$CanvasSizeOptions' => NULL, ], ], 'GridLayoutConfiguration' => [ 'base' => '

The configuration for a grid layout. Also called a tiled layout.

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

', 'refs' => [ 'LayoutConfiguration$GridLayout' => '

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

', 'SheetControlLayoutConfiguration$GridLayout' => '

The configuration that determines the elements and canvas size options of sheet control.

', ], ], 'GridLayoutElement' => [ 'base' => '

An element within a grid layout.

', 'refs' => [ 'GridLayoutElementList$member' => NULL, ], ], 'GridLayoutElementColumnIndex' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$ColumnIndex' => '

The column index for the upper left corner of an element.

', ], ], 'GridLayoutElementColumnSpan' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$ColumnSpan' => '

The width of a grid element expressed as a number of grid columns.

', ], ], 'GridLayoutElementList' => [ 'base' => NULL, 'refs' => [ 'GridLayoutConfiguration$Elements' => '

The elements that are included in a grid layout.

', ], ], 'GridLayoutElementRowIndex' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$RowIndex' => '

The row index for the upper left corner of an element.

', ], ], 'GridLayoutElementRowSpan' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$RowSpan' => '

The height of a grid element expressed as a number of grid rows.

', ], ], 'GridLayoutScreenCanvasSizeOptions' => [ 'base' => '

The options that determine the sizing of the canvas used in a grid layout.

', 'refs' => [ 'GridLayoutCanvasSizeOptions$ScreenCanvasSizeOptions' => '

The options that determine the sizing of the canvas used in a grid layout.

', ], ], 'Group' => [ 'base' => '

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

', 'refs' => [ 'CreateGroupResponse$Group' => '

The name of the group.

', 'DescribeGroupResponse$Group' => '

The name of the group.

', 'GroupList$member' => NULL, 'UpdateGroupResponse$Group' => '

The name of the group.

', ], ], 'GroupDescription' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Description' => '

A description for the group that you want to create.

', 'Group$Description' => '

The group description.

', 'UpdateGroupRequest$Description' => '

The description for the group that you want to update.

', ], ], 'GroupFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'GroupSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME". Currently, the only supported name is GROUP_NAME.

', ], ], 'GroupFilterOperator' => [ 'base' => NULL, 'refs' => [ 'GroupSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StartsWith". Currently, the only supported operator is StartsWith.

', ], ], 'GroupList' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$GroupList' => '

The list of the groups.

', 'ListUserGroupsResponse$GroupList' => '

The list of groups the user is a member of.

', 'SearchGroupsResponse$GroupList' => '

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

', ], ], 'GroupMember' => [ 'base' => '

A member of an Amazon QuickSight group. Currently, group members must be users. Groups can\'t be members of another group. .

', 'refs' => [ 'CreateGroupMembershipResponse$GroupMember' => '

The group member.

', 'DescribeGroupMembershipResponse$GroupMember' => NULL, 'GroupMemberList$member' => NULL, ], ], 'GroupMemberList' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembershipsResponse$GroupMemberList' => '

The list of the members of the group.

', ], ], 'GroupMemberName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$MemberName' => '

The name of the user that you want to add to the group membership.

', 'DeleteGroupMembershipRequest$MemberName' => '

The name of the user that you want to delete from the group membership.

', 'DescribeGroupMembershipRequest$MemberName' => '

The user name of the user that you want to search for.

', 'GroupMember$MemberName' => '

The name of the group member (user).

', ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$GroupName' => '

The name of the group that you want to add the user to.

', 'CreateGroupRequest$GroupName' => '

A name for the group that you want to create.

', 'CreateRoleMembershipRequest$MemberName' => '

The name of the group that you want to add to the role.

', 'DeleteGroupMembershipRequest$GroupName' => '

The name of the group that you want to delete the user from.

', 'DeleteGroupRequest$GroupName' => '

The name of the group that you want to delete.

', 'DeleteRoleMembershipRequest$MemberName' => '

The name of the group.

', 'DescribeGroupMembershipRequest$GroupName' => '

The name of the group that you want to search.

', 'DescribeGroupRequest$GroupName' => '

The name of the group that you want to describe.

', 'Group$GroupName' => '

The name of the group.

', 'ListGroupMembershipsRequest$GroupName' => '

The name of the group that you want to see a membership list of.

', 'UpdateGroupRequest$GroupName' => '

The name of the group that you want to update.

', ], ], 'GroupSearchFilter' => [ 'base' => '

A GroupSearchFilter object that you want to apply to your search.

', 'refs' => [ 'GroupSearchFilterList$member' => NULL, ], ], 'GroupSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchGroupsRequest$Filters' => '

The structure for the search filters that you want to apply to your search.

', ], ], 'GroupsList' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AdminGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AuthorGroup' => '

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.

', 'CreateAccountSubscriptionRequest$ReaderGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AdminProGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AuthorProGroup' => '

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.

', 'CreateAccountSubscriptionRequest$ReaderProGroup' => '

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.

', 'ListRoleMembershipsResponse$MembersList' => '

The list of groups associated with a role

', ], ], 'GrowthRateComputation' => [ 'base' => '

The growth rate computation configuration.

', 'refs' => [ 'Computation$GrowthRate' => '

The growth rate computation configuration.

', ], ], 'GrowthRatePeriodSize' => [ 'base' => NULL, 'refs' => [ 'GrowthRateComputation$PeriodSize' => '

The period size setup of a growth rate computation.

', ], ], 'GutterStyle' => [ 'base' => '

The display options for gutter spacing between tiles on a sheet.

', 'refs' => [ 'TileLayoutStyle$Gutter' => '

The gutter settings that apply between tiles.

', ], ], 'HeaderFooterSectionConfiguration' => [ 'base' => '

The configuration of a header or footer section.

', 'refs' => [ 'HeaderFooterSectionConfigurationList$member' => NULL, ], ], 'HeaderFooterSectionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutConfiguration$HeaderSections' => '

A list of header section configurations.

', 'SectionBasedLayoutConfiguration$FooterSections' => '

A list of footer section configurations.

', ], ], 'HeatMapAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a heat map.

', 'refs' => [ 'HeatMapFieldWells$HeatMapAggregatedFieldWells' => '

The aggregated field wells of a heat map.

', ], ], 'HeatMapConfiguration' => [ 'base' => '

The configuration of a heat map.

', 'refs' => [ 'HeatMapVisual$ChartConfiguration' => '

The configuration of a heat map.

', ], ], 'HeatMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'HeatMapAggregatedFieldWells$Rows' => '

The rows field well of a heat map.

', 'HeatMapAggregatedFieldWells$Columns' => '

The columns field well of a heat map.

', ], ], 'HeatMapFieldWells' => [ 'base' => '

The field well configuration of a heat map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'HeatMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'HeatMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'HeatMapAggregatedFieldWells$Values' => '

The values field well of a heat map.

', ], ], 'HeatMapSortConfiguration' => [ 'base' => '

The sort configuration of a heat map.

', 'refs' => [ 'HeatMapConfiguration$SortConfiguration' => '

The sort configuration of a heat map.

', ], ], 'HeatMapVisual' => [ 'base' => '

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$HeatMapVisual' => '

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

', ], ], 'HexColor' => [ 'base' => NULL, 'refs' => [ 'ColorList$member' => NULL, 'ConditionalFormattingCustomIconCondition$Color' => '

Determines the color of the icon.

', 'ConditionalFormattingSolidColor$Color' => '

Determines the color.

', 'CustomColor$Color' => '

The color that is applied to the data value.

', 'DataBarsOptions$PositiveColor' => '

The color of the positive data bar.

', 'DataBarsOptions$NegativeColor' => '

The color of the negative data bar.

', 'DataColor$Color' => '

The color that is applied to the data value.

', 'DataColorPalette$EmptyFillColor' => '

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

', 'DataLabelOptions$LabelColor' => '

Determines the color of the data labels.

', 'DataPathColor$Color' => '

The color that needs to be applied to the element.

', 'FontConfiguration$FontColor' => '

Determines the color of the text.

', 'FunnelChartDataLabelOptions$LabelColor' => '

The color of the data label text.

', 'GaugeChartColorConfiguration$ForegroundColor' => '

The foreground color configuration of a GaugeChartVisual.

', 'GaugeChartColorConfiguration$BackgroundColor' => '

The background color configuration of a GaugeChartVisual.

', 'GeospatialHeatmapDataColor$Color' => '

The hex color to be used in the heatmap point style.

', 'GradientStop$Color' => '

Determines the color.

', 'KPISparklineOptions$Color' => '

The color of the sparkline.

', 'LineChartMarkerStyleSettings$MarkerColor' => '

Color of marker in the series.

', 'RadarChartConfiguration$AlternateBandEvenColor' => '

The color of the even-numbered alternate bands of a radar chart.

', 'RadarChartConfiguration$AlternateBandOddColor' => '

The color of the odd-numbered alternate bands of a radar chart.

', 'ReferenceLineLabelConfiguration$FontColor' => '

The font color configuration of the label in a reference line.

', 'ReferenceLineStyleConfiguration$Color' => '

The hex color of the reference line.

', 'RowAlternateColorList$member' => NULL, 'SimpleClusterMarker$Color' => '

The color of the simple cluster marker.

', 'TableBorderOptions$Color' => '

The color of a table border.

', 'TableCellStyle$BackgroundColor' => '

The background color for the table cells.

', 'UIColorPalette$PrimaryForeground' => '

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

', 'UIColorPalette$PrimaryBackground' => '

The background color that applies to visuals and other high emphasis UI.

', 'UIColorPalette$SecondaryForeground' => '

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

', 'UIColorPalette$SecondaryBackground' => '

The background color that applies to the sheet background and sheet controls.

', 'UIColorPalette$Accent' => '

This color is that applies to selected states and buttons.

', 'UIColorPalette$AccentForeground' => '

The foreground color that applies to any text or other elements that appear over the accent color.

', 'UIColorPalette$Danger' => '

The color that applies to error messages.

', 'UIColorPalette$DangerForeground' => '

The foreground color that applies to any text or other elements that appear over the error color.

', 'UIColorPalette$Warning' => '

This color that applies to warning and informational messages.

', 'UIColorPalette$WarningForeground' => '

The foreground color that applies to any text or other elements that appear over the warning color.

', 'UIColorPalette$Success' => '

The color that applies to success messages, for example the check mark for a successful download.

', 'UIColorPalette$SuccessForeground' => '

The foreground color that applies to any text or other elements that appear over the success color.

', 'UIColorPalette$Dimension' => '

The color that applies to the names of fields that are identified as dimensions.

', 'UIColorPalette$DimensionForeground' => '

The foreground color that applies to any text or other elements that appear over the dimension color.

', 'UIColorPalette$Measure' => '

The color that applies to the names of fields that are identified as measures.

', 'UIColorPalette$MeasureForeground' => '

The foreground color that applies to any text or other elements that appear over the measure color.

', 'VisualPalette$ChartColor' => '

The chart color options for the visual palette.

', 'WaterfallChartGroupColorConfiguration$PositiveBarColor' => '

Defines the color for the positive bars of a waterfall chart.

', 'WaterfallChartGroupColorConfiguration$NegativeBarColor' => '

Defines the color for the negative bars of a waterfall chart.

', 'WaterfallChartGroupColorConfiguration$TotalBarColor' => '

Defines the color for the total bars of a waterfall chart.

', ], ], 'HexColorWithTransparency' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElementBackgroundStyle$Color' => '

The background color of a free-form layout element.

', 'FreeFormLayoutElementBorderStyle$Color' => '

The border color of a free-form layout element.

', 'PanelConfiguration$BorderColor' => '

Sets the line color of panel borders.

', 'PanelConfiguration$BackgroundColor' => '

Sets the background color for each panel.

', ], ], 'HierarchyId' => [ 'base' => NULL, 'refs' => [ 'CategoricalDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'DateDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'DateTimeHierarchy$HierarchyId' => '

The hierarchy ID of the DateTime hierarchy.

', 'ExplicitHierarchy$HierarchyId' => '

The hierarchy ID of the explicit hierarchy.

', 'NumericalDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'PredefinedHierarchy$HierarchyId' => '

The hierarchy ID of the predefined hierarchy.

', ], ], 'HistogramAggregatedFieldWells' => [ 'base' => '

The field well configuration of a histogram.

', 'refs' => [ 'HistogramFieldWells$HistogramAggregatedFieldWells' => '

The field well configuration of a histogram.

', ], ], 'HistogramBinOptions' => [ 'base' => '

The options that determine the presentation of histogram bins.

', 'refs' => [ 'HistogramConfiguration$BinOptions' => '

The options that determine the presentation of histogram bins.

', ], ], 'HistogramBinType' => [ 'base' => NULL, 'refs' => [ 'HistogramBinOptions$SelectedBinType' => '

The options that determine the selected bin type.

', ], ], 'HistogramConfiguration' => [ 'base' => '

The configuration for a HistogramVisual.

', 'refs' => [ 'HistogramVisual$ChartConfiguration' => '

The configuration for a HistogramVisual.

', ], ], 'HistogramFieldWells' => [ 'base' => '

The field well configuration of a histogram.

', 'refs' => [ 'HistogramConfiguration$FieldWells' => '

The field well configuration of a histogram.

', ], ], 'HistogramMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'HistogramAggregatedFieldWells$Values' => '

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

', ], ], 'HistogramVisual' => [ 'base' => '

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$HistogramVisual' => '

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

', ], ], 'HorizontalTextAlignment' => [ 'base' => NULL, 'refs' => [ 'PanelTitleOptions$HorizontalTextAlignment' => '

Sets the horizontal text alignment of the title within each panel.

', 'TableCellStyle$HorizontalTextAlignment' => '

The horizontal text alignment (left, center, right, auto) for the table cells.

', ], ], 'Host' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Host' => '

Host.

', 'AuroraPostgreSqlParameters$Host' => '

The Amazon Aurora PostgreSQL-Compatible host to connect to.

', 'DatabricksParameters$Host' => '

The host name of the Databricks data source.

', 'ExasolParameters$Host' => '

The hostname or IP address of the Exasol data source.

', 'MariaDbParameters$Host' => '

Host.

', 'MySqlParameters$Host' => '

Host.

', 'OracleParameters$Host' => '

An Oracle host.

', 'PostgreSqlParameters$Host' => '

Host.

', 'PrestoParameters$Host' => '

Host.

', 'RedshiftParameters$Host' => '

Host. This field can be blank if ClusterId is provided.

', 'SnowflakeParameters$Host' => '

Host.

', 'SparkParameters$Host' => '

Host.

', 'SqlServerParameters$Host' => '

Host.

', 'StarburstParameters$Host' => '

The host name of the Starburst data source.

', 'TeradataParameters$Host' => '

Host.

', 'TrinoParameters$Host' => '

The host name of the Trino data source.

', ], ], 'IAMPolicyAssignment' => [ 'base' => '

An Identity and Access Management (IAM) policy assignment.

', 'refs' => [ 'DescribeIAMPolicyAssignmentResponse$IAMPolicyAssignment' => '

Information describing the IAM policy assignment.

', ], ], 'IAMPolicyAssignmentName' => [ 'base' => NULL, 'refs' => [ 'ActiveIAMPolicyAssignment$AssignmentName' => '

A name for the IAM policy assignment.

', 'CreateIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

', 'CreateIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment. The name must be unique within the Amazon Web Services account.

', 'DeleteIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment.

', 'DeleteIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment.

', 'DescribeIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule.

', 'IAMPolicyAssignment$AssignmentName' => '

Assignment name.

', 'IAMPolicyAssignmentSummary$AssignmentName' => '

Assignment name.

', 'UpdateIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

', 'UpdateIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment or rule.

', ], ], 'IAMPolicyAssignmentSummary' => [ 'base' => '

IAM policy assignment summary.

', 'refs' => [ 'IAMPolicyAssignmentSummaryList$member' => NULL, ], ], 'IAMPolicyAssignmentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListIAMPolicyAssignmentsResponse$IAMPolicyAssignments' => '

Information describing the IAM policy assignments.

', ], ], 'IPv4Address' => [ 'base' => NULL, 'refs' => [ 'DnsResolverList$member' => NULL, ], ], 'Icon' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingCustomIconOptions$Icon' => '

Determines the type of icon.

', ], ], 'Identifier' => [ 'base' => '

The definition for the identifier.

', 'refs' => [ 'CalculatedFieldReferenceList$member' => NULL, 'FilterAggMetrics$MetricOperand' => '

The metric operand of the FilterAggMetrics.

', 'OperandList$member' => NULL, 'TopicIRFilterOption$OperandField' => '

The operand field for the TopicIRFilterOption.

', 'TopicIRGroupBy$FieldName' => '

The field name for the TopicIRGroupBy.

', 'TopicIRMetric$MetricId' => '

The metric ID for the TopicIRMetric.

', 'TopicSortClause$Operand' => '

The operand for a TopicSortClause.

', ], ], 'IdentityCenterConfiguration' => [ 'base' => '

The parameters for an IAM Identity Center configuration.

', 'refs' => [ 'RedshiftParameters$IdentityCenterConfiguration' => '

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.

', ], ], 'IdentityMap' => [ 'base' => NULL, 'refs' => [ 'CreateIAMPolicyAssignmentRequest$Identities' => '

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

', 'CreateIAMPolicyAssignmentResponse$Identities' => '

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

', 'IAMPolicyAssignment$Identities' => '

Identities.

', 'UpdateIAMPolicyAssignmentRequest$Identities' => '

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

', 'UpdateIAMPolicyAssignmentResponse$Identities' => '

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

', ], ], 'IdentityName' => [ 'base' => NULL, 'refs' => [ 'IdentityNameList$member' => NULL, ], ], 'IdentityNameList' => [ 'base' => NULL, 'refs' => [ 'IdentityMap$value' => NULL, ], ], 'IdentityStore' => [ 'base' => NULL, 'refs' => [ 'CreateNamespaceRequest$IdentityStore' => '

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

', 'CreateNamespaceResponse$IdentityStore' => '

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

', 'NamespaceInfoV2$IdentityStore' => '

The identity store used for the namespace.

', ], ], 'IdentityType' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$IdentityType' => '

The identity type that your Amazon QuickSight account uses to manage the identity of users.

', 'User$IdentityType' => '

The type of identity authentication used by the user.

', ], ], 'IdentityTypeNotSupportedException' => [ 'base' => '

The identity type specified isn\'t supported. Supported identity types include IAM and QUICKSIGHT.

', 'refs' => [], ], 'IncrementalRefresh' => [ 'base' => '

The incremental refresh configuration for a dataset.

', 'refs' => [ 'RefreshConfiguration$IncrementalRefresh' => '

The incremental refresh for the dataset.

', ], ], 'Ingestion' => [ 'base' => '

Information about the SPICE ingestion for a dataset.

', 'refs' => [ 'DescribeIngestionResponse$Ingestion' => '

Information about the ingestion.

', 'Ingestions$member' => NULL, ], ], 'IngestionErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorInfo$Type' => '

Error type.

', ], ], 'IngestionId' => [ 'base' => NULL, 'refs' => [ 'CancelIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'CancelIngestionResponse$IngestionId' => '

An ID for the ingestion.

', 'CreateIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'CreateIngestionResponse$IngestionId' => '

An ID for the ingestion.

', 'DescribeIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'Ingestion$IngestionId' => '

Ingestion ID.

', ], ], 'IngestionMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListIngestionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', ], ], 'IngestionRequestSource' => [ 'base' => NULL, 'refs' => [ 'Ingestion$RequestSource' => '

Event source for this ingestion.

', ], ], 'IngestionRequestType' => [ 'base' => 'This defines the type of ingestion request. This is returned as part of create ingestion response.', 'refs' => [ 'Ingestion$RequestType' => '

Type of this ingestion.

', ], ], 'IngestionStatus' => [ 'base' => NULL, 'refs' => [ 'CreateIngestionResponse$IngestionStatus' => '

The ingestion status.

', 'Ingestion$IngestionStatus' => '

Ingestion status.

', ], ], 'IngestionType' => [ 'base' => 'This defines the type of ingestion user wants to trigger. This is part of create ingestion request.', 'refs' => [ 'CreateIngestionRequest$IngestionType' => '

The type of ingestion that you want to create.

', 'RefreshSchedule$RefreshType' => '

The type of refresh that a datset undergoes. Valid values are as follows:

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

', ], ], 'Ingestions' => [ 'base' => NULL, 'refs' => [ 'ListIngestionsResponse$Ingestions' => '

A list of the ingestions.

', ], ], 'InnerFilter' => [ 'base' => '

The InnerFilter defines the subset of data to be used with the NestedFilter.

', 'refs' => [ 'NestedFilter$InnerFilter' => '

The InnerFilter defines the subset of data to be used with the NestedFilter.

', ], ], 'InputColumn' => [ 'base' => '

Metadata for a column that is used as the input of a transform operation.

', 'refs' => [ 'InputColumnList$member' => NULL, ], ], 'InputColumnDataType' => [ 'base' => NULL, 'refs' => [ 'InputColumn$Type' => '

The data type of the column.

', ], ], 'InputColumnList' => [ 'base' => NULL, 'refs' => [ 'CustomSql$Columns' => '

The column schema from the SQL query result set.

', 'RelationalTable$InputColumns' => '

The column schema of the table.

', 'S3Source$InputColumns' => '

A physical table type for an S3 data source.

For files that aren\'t JSON, only STRING data types are supported in input columns.

', ], ], 'InsightConfiguration' => [ 'base' => '

The configuration of an insight visual.

', 'refs' => [ 'InsightVisual$InsightConfiguration' => '

The configuration of an insight visual.

', ], ], 'InsightVisual' => [ 'base' => '

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$InsightVisual' => '

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'RdsParameters$InstanceId' => '

Instance ID.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Anchor$Offset' => '

The offset of the Anchor.

', 'ArcAxisConfiguration$ReserveRange' => '

The reserved range of the arc axis.

', 'AxisLinearScale$StepCount' => '

The step count setup of a linear axis.

', 'DisplayFormatOptions$FractionDigits' => '

Determines the number of fraction digits.

', 'ExcludePeriodConfiguration$Amount' => '

The amount or number of the exclude period.

', 'RelativeDatesFilter$RelativeDateValue' => '

The date value of the filter.

', 'TopBottomFilter$Limit' => '

The number of items to include in the top bottom filter results.

', 'TopicIRComparisonMethod$WindowSize' => '

The window size for the TopicIRComparisonMethod.

', ], ], 'IntegerDatasetParameter' => [ 'base' => '

An integer parameter for a dataset.

', 'refs' => [ 'DatasetParameter$IntegerDatasetParameter' => '

An integer parameter that is created in the dataset.

', ], ], 'IntegerDatasetParameterDefaultValue' => [ 'base' => '

The default value for the integer parameter.

', 'refs' => [ 'IntegerDatasetParameterValueList$member' => NULL, ], ], 'IntegerDatasetParameterDefaultValues' => [ 'base' => '

The default values of an integer parameter.

', 'refs' => [ 'IntegerDatasetParameter$DefaultValues' => '

A list of default values for a given integer parameter. This structure only accepts static values.

', ], ], 'IntegerDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'IntegerDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given integer parameter.

', 'NewDefaultValues$IntegerStaticValues' => '

A list of static default values for a given integer parameter.

', ], ], 'IntegerDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$IntegerValues' => '

A list of integer-type parameter values.

', 'IntegerDefaultValues$StaticValues' => '

The static values of the IntegerDefaultValues.

', ], ], 'IntegerDefaultValues' => [ 'base' => '

The default values of the IntegerParameterDeclaration.

', 'refs' => [ 'IntegerParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'IntegerParameter' => [ 'base' => '

An integer parameter.

', 'refs' => [ 'IntegerParameterList$member' => NULL, ], ], 'IntegerParameterDeclaration' => [ 'base' => '

A parameter declaration for the Integer data type.

', 'refs' => [ 'ParameterDeclaration$IntegerParameterDeclaration' => '

A parameter declaration for the Integer data type.

', ], ], 'IntegerParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$IntegerParameters' => '

The parameters that have a data type of integer.

', ], ], 'IntegerValueWhenUnsetConfiguration' => [ 'base' => '

A parameter declaration for the Integer data type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'IntegerParameterDeclaration$ValueWhenUnset' => '

A parameter declaration for the Integer data type.

', ], ], 'InternalFailureException' => [ 'base' => '

An internal failure occurred.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The NextToken value isn\'t valid.

', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => '

One or more parameters has a value that isn\'t valid.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

You don\'t have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

', 'refs' => [], ], 'InvalidTopicReviewedAnswer' => [ 'base' => '

The definition for a InvalidTopicReviewedAnswer.

', 'refs' => [ 'InvalidTopicReviewedAnswers$member' => NULL, ], ], 'InvalidTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$InvalidAnswers' => '

The definition of Answers that are invalid and not created.

', 'BatchDeleteTopicReviewedAnswerResponse$InvalidAnswers' => '

The definition of Answers that are invalid and not deleted.

', ], ], 'IpRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'IpRestrictionRuleMap$value' => NULL, ], ], 'IpRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$IpRestrictionRuleMap' => '

A map that describes the IP rules with CIDR range and description.

', 'UpdateIpRestrictionRequest$IpRestrictionRuleMap' => '

A map that describes the updated IP rules with CIDR ranges and descriptions.

', ], ], 'ItemsLimitConfiguration' => [ 'base' => '

The limit configuration of the visual display for an axis.

', 'refs' => [ 'BarChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories displayed in a bar chart.

', 'BarChartSortConfiguration$ColorItemsLimit' => '

The limit on the number of values displayed in a bar chart.

', 'BarChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'ComboChartSortConfiguration$CategoryItemsLimit' => '

The item limit configuration for the category field well of a combo chart.

', 'ComboChartSortConfiguration$ColorItemsLimit' => '

The item limit configuration of the color field well in a combo chart.

', 'FunnelChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories displayed.

', 'HeatMapSortConfiguration$HeatMapRowItemsLimitConfiguration' => '

The limit on the number of rows that are displayed in a heat map.

', 'HeatMapSortConfiguration$HeatMapColumnItemsLimitConfiguration' => '

The limit on the number of columns that are displayed in a heat map.

', 'LineChartSortConfiguration$CategoryItemsLimitConfiguration' => '

The limit on the number of categories that are displayed in a line chart.

', 'LineChartSortConfiguration$ColorItemsLimitConfiguration' => '

The limit on the number of lines that are displayed in a line chart.

', 'LineChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'PieChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories that are displayed in a pie chart.

', 'PieChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'RadarChartSortConfiguration$CategoryItemsLimit' => '

The category items limit for a radar chart.

', 'RadarChartSortConfiguration$ColorItemsLimit' => '

The color items limit of a radar chart.

', 'SankeyDiagramSortConfiguration$SourceItemsLimit' => '

The limit on the number of source nodes that are displayed in a sankey diagram.

', 'SankeyDiagramSortConfiguration$DestinationItemsLimit' => '

The limit on the number of destination nodes that are displayed in a sankey diagram.

', 'ScatterPlotSortConfiguration$ScatterPlotLimitConfiguration' => NULL, 'TreeMapSortConfiguration$TreeMapGroupItemsLimitConfiguration' => '

The limit on the number of groups that are displayed.

', 'WaterfallChartSortConfiguration$BreakdownItemsLimit' => '

The limit on the number of bar groups that are displayed.

', 'WordCloudSortConfiguration$CategoryItemsLimit' => '

The limit on the number of groups that are displayed in a word cloud.

', ], ], 'JiraParameters' => [ 'base' => '

The parameters for Jira.

', 'refs' => [ 'DataSourceParameters$JiraParameters' => '

The parameters for Jira.

', ], ], 'JoinInstruction' => [ 'base' => '

The instructions associated with a join.

', 'refs' => [ 'LogicalTableSource$JoinInstruction' => '

Specifies the result of a join of two logical tables.

', ], ], 'JoinKeyProperties' => [ 'base' => '

Properties associated with the columns participating in a join.

', 'refs' => [ 'JoinInstruction$LeftJoinKeyProperties' => '

Join key properties of the left operand.

', 'JoinInstruction$RightJoinKeyProperties' => '

Join key properties of the right operand.

', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'JoinInstruction$Type' => '

The type of join that it is.

', ], ], 'KPIActualValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the actual value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ActualValue' => '

The conditional formatting for the actual value of a KPI visual.

', ], ], 'KPIComparisonValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the comparison value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ComparisonValue' => '

The conditional formatting for the comparison value of a KPI visual.

', ], ], 'KPIConditionalFormatting' => [ 'base' => '

The conditional formatting of a KPI visual.

', 'refs' => [ 'KPIVisual$ConditionalFormatting' => '

The conditional formatting of a KPI visual.

', ], ], 'KPIConditionalFormattingOption' => [ 'base' => '

The conditional formatting options of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOptionList$member' => NULL, ], ], 'KPIConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'KPIConditionalFormatting$ConditionalFormattingOptions' => '

The conditional formatting options of a KPI visual.

', ], ], 'KPIConfiguration' => [ 'base' => '

The configuration of a KPI visual.

', 'refs' => [ 'KPIVisual$ChartConfiguration' => '

The configuration of a KPI visual.

', ], ], 'KPIFieldWells' => [ 'base' => '

The field well configuration of a KPI visual.

', 'refs' => [ 'KPIConfiguration$FieldWells' => '

The field well configuration of a KPI visual.

', ], ], 'KPIOptions' => [ 'base' => '

The options that determine the presentation of a KPI visual.

', 'refs' => [ 'KPIConfiguration$KPIOptions' => '

The options that determine the presentation of a KPI visual.

', ], ], 'KPIPrimaryValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the primary value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$PrimaryValue' => '

The conditional formatting for the primary value of a KPI visual.

', ], ], 'KPIProgressBarConditionalFormatting' => [ 'base' => '

The conditional formatting for the progress bar of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ProgressBar' => '

The conditional formatting for the progress bar of a KPI visual.

', ], ], 'KPISortConfiguration' => [ 'base' => '

The sort configuration of a KPI visual.

', 'refs' => [ 'KPIConfiguration$SortConfiguration' => '

The sort configuration of a KPI visual.

', ], ], 'KPISparklineOptions' => [ 'base' => '

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

', 'refs' => [ 'KPIOptions$Sparkline' => '

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

', ], ], 'KPISparklineType' => [ 'base' => NULL, 'refs' => [ 'KPISparklineOptions$Type' => '

The type of the sparkline.

', ], ], 'KPIVisual' => [ 'base' => '

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$KPIVisual' => '

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

', ], ], 'KPIVisualLayoutOptions' => [ 'base' => '

The options that determine the layout a KPI visual.

', 'refs' => [ 'KPIOptions$VisualLayoutOptions' => '

The options that determine the layout a KPI visual.

', ], ], 'KPIVisualStandardLayout' => [ 'base' => '

The standard layout of the KPI visual.

', 'refs' => [ 'KPIVisualLayoutOptions$StandardLayout' => '

The standard layout of the KPI visual.

', ], ], 'KPIVisualStandardLayoutType' => [ 'base' => NULL, 'refs' => [ 'KPIVisualStandardLayout$Type' => '

The standard layout type.

', ], ], 'KeyRegistration' => [ 'base' => NULL, 'refs' => [ 'DescribeKeyRegistrationResponse$KeyRegistration' => '

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

', 'UpdateKeyRegistrationRequest$KeyRegistration' => '

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

', ], ], 'LabelOptions' => [ 'base' => '

The share label options for the labels.

', 'refs' => [ 'AxisTickLabelOptions$LabelOptions' => '

Determines whether or not the axis ticks are visible.

', 'DateTimePickerControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'DropDownControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'LegendOptions$Title' => '

The custom title for the legend.

', 'ListControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'RelativeDateTimeControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'SliderControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'TextAreaControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'TextFieldControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', ], ], 'Latitude' => [ 'base' => NULL, 'refs' => [ 'GeospatialCoordinateBounds$North' => '

The latitude of the north bound of the geospatial coordinate bounds.

', 'GeospatialCoordinateBounds$South' => '

The latitude of the south bound of the geospatial coordinate bounds.

', ], ], 'Layout' => [ 'base' => '

A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon QuickSight User Guide.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'LayoutList$member' => NULL, ], ], 'LayoutConfiguration' => [ 'base' => '

The configuration that determines what the type of layout will be used on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'Layout$Configuration' => '

The configuration that determines what the type of layout for a sheet.

', ], ], 'LayoutElementType' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElement$ElementType' => '

The type of element.

', 'GridLayoutElement$ElementType' => '

The type of element.

', ], ], 'LayoutList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Layouts' => '

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

', ], ], 'LegendOptions' => [ 'base' => '

The options for the legend setup of a visual.

', 'refs' => [ 'BarChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'BoxPlotChartConfiguration$Legend' => NULL, 'ComboChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'FilledMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'GeospatialMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'HeatMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'LineChartConfiguration$Legend' => '

The legend configuration of a line chart.

', 'PieChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'RadarChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'ScatterPlotConfiguration$Legend' => '

The legend display setup of the visual.

', 'TreeMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'WaterfallChartConfiguration$Legend' => '

The legend configuration of a waterfall visual.

', ], ], 'LegendPosition' => [ 'base' => NULL, 'refs' => [ 'LegendOptions$Position' => '

The positions for the legend. Choose one of the following options:

', ], ], 'Length' => [ 'base' => 'String based length that is composed of value and unit', 'refs' => [ 'Spacing$Top' => '

Define the top spacing.

', 'Spacing$Bottom' => '

Define the bottom spacing.

', 'Spacing$Left' => '

Define the left spacing.

', 'Spacing$Right' => '

Define the right spacing.

', ], ], 'LimitExceededException' => [ 'base' => '

A limit is exceeded.

', 'refs' => [], ], 'LimitedString' => [ 'base' => NULL, 'refs' => [ 'AggFunction$PeriodField' => '

The period field for an Agg function.

', 'AggregationFunctionParameters$key' => NULL, 'AggregationFunctionParameters$value' => NULL, 'AggregationPartitionBy$FieldName' => '

The field Name for an AggregationPartitionBy.

', 'CellValueSynonym$CellValue' => '

The cell value.

', 'ContributionAnalysisFactor$FieldName' => '

The field name of the ContributionAnalysisFactor.

', 'CreateTopicReviewedAnswer$Question' => '

The Question to be created.

', 'DataAggregation$DefaultDateColumnName' => '

The column name for the default date.

', 'DatasetMetadata$DatasetName' => '

The name of the dataset.

', 'DatasetMetadata$DatasetDescription' => '

The description of the dataset.

', 'DisplayFormatOptions$BlankCellFormat' => '

Determines the blank cell format.

', 'DisplayFormatOptions$DateFormat' => '

Determines the DateTime format.

', 'DisplayFormatOptions$GroupingSeparator' => '

Determines the grouping separator.

', 'DisplayFormatOptions$Prefix' => '

The prefix value for a display format.

', 'DisplayFormatOptions$Suffix' => '

The suffix value for a display format.

', 'DisplayFormatOptions$CurrencySymbol' => '

The currency symbol, such as USD.

', 'Identifier$Identity' => '

The identity of the identifier.

', 'NamedEntityDefinition$FieldName' => '

The name of the entity.

', 'NamedEntityDefinition$PropertyName' => '

The property name to be used for the named entity.

', 'NamedEntityRef$NamedEntityName' => '

The NamedEntityName for the NamedEntityRef.

', 'NegativeFormat$Prefix' => '

The prefix for a negative format.

', 'NegativeFormat$Suffix' => '

The suffix for a negative format.

', 'RangeConstant$Minimum' => '

The minimum value for a range constant.

', 'RangeConstant$Maximum' => '

The maximum value for a range constant.

', 'SemanticEntityType$TypeName' => '

The semantic entity type name.

', 'SemanticEntityType$SubTypeName' => '

The semantic entity sub type name.

', 'SemanticType$TypeName' => '

The semantic type name.

', 'SemanticType$SubTypeName' => '

The semantic type sub type name.

', 'Slot$SlotId' => '

The slot ID of the slot.

', 'Slot$VisualId' => '

The visual ID for the slot.

', 'Synonyms$member' => NULL, 'TopicCalculatedField$CalculatedFieldName' => '

The calculated field name.

', 'TopicCalculatedField$CalculatedFieldDescription' => '

The calculated field description.

', 'TopicCategoryFilterConstant$SingularConstant' => '

A singular constant used in a category filter. This element is used to specify a single value for the constant.

', 'TopicColumn$ColumnName' => '

The name of the column.

', 'TopicColumn$ColumnFriendlyName' => '

A user-friendly name for the column.

', 'TopicColumn$ColumnDescription' => '

A description of the column and its contents.

', 'TopicDetails$Description' => '

The description of the topic.

', 'TopicFilter$FilterDescription' => '

A description of the filter used to select items for a topic.

', 'TopicFilter$FilterName' => '

The name of the filter.

', 'TopicFilter$OperandFieldName' => '

The name of the field that the filter operates on.

', 'TopicNamedEntity$EntityName' => '

The name of the named entity.

', 'TopicNamedEntity$EntityDescription' => '

The description of the named entity.

', 'TopicRefreshSchedule$Timezone' => '

The timezone that you want the refresh schedule to use.

', 'TopicRefreshSchedule$RepeatAt' => '

The time of day when the refresh should run, for example, Monday-Sunday.

', 'TopicRefreshScheduleSummary$DatasetId' => '

The ID of the dataset.

', 'TopicRefreshScheduleSummary$DatasetName' => '

The name of the dataset.

', 'TopicReviewedAnswer$Question' => '

The question for the TopicReviewedAnswer.

', 'TopicSingularFilterConstant$SingularConstant' => '

The value of the singular filter constant.

', 'TopicTemplate$TemplateType' => '

The template type for the TopicTemplate.

', 'TopicVisual$VisualId' => '

The visual ID for the TopicVisual.

', 'TypeParameters$key' => NULL, 'TypeParameters$value' => NULL, 'VisualOptions$type' => '

The type for a VisualOptions.

', ], ], 'LineChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a line chart.

', 'refs' => [ 'LineChartFieldWells$LineChartAggregatedFieldWells' => '

The field well configuration of a line chart.

', ], ], 'LineChartConfiguration' => [ 'base' => '

The configuration of a line chart.

', 'refs' => [ 'LineChartVisual$ChartConfiguration' => '

The configuration of a line chart.

', ], ], 'LineChartDefaultSeriesSettings' => [ 'base' => '

The options that determine the default presentation of all line series in LineChartVisual.

', 'refs' => [ 'LineChartConfiguration$DefaultSeriesSettings' => '

The options that determine the default presentation of all line series in LineChartVisual.

', ], ], 'LineChartFieldWells' => [ 'base' => '

The field well configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$FieldWells' => '

The field well configuration of a line chart.

', ], ], 'LineChartLineStyle' => [ 'base' => NULL, 'refs' => [ 'LineChartLineStyleSettings$LineStyle' => '

Line style for line series.

', ], ], 'LineChartLineStyleSettings' => [ 'base' => '

Line styles options for a line series in LineChartVisual.

', 'refs' => [ 'LineChartDefaultSeriesSettings$LineStyleSettings' => '

Line styles options for all line series in the visual.

', 'LineChartSeriesSettings$LineStyleSettings' => '

Line styles options for a line series in LineChartVisual.

', ], ], 'LineChartMarkerShape' => [ 'base' => NULL, 'refs' => [ 'LineChartMarkerStyleSettings$MarkerShape' => '

Shape option for markers in the series.

', ], ], 'LineChartMarkerStyleSettings' => [ 'base' => '

Marker styles options for a line series in LineChartVisual.

', 'refs' => [ 'LineChartDefaultSeriesSettings$MarkerStyleSettings' => '

Marker styles options for all line series in the visual.

', 'LineChartSeriesSettings$MarkerStyleSettings' => '

Marker styles options for a line series in LineChartVisual.

', ], ], 'LineChartSeriesSettings' => [ 'base' => '

The options that determine the presentation of a line series in the visual

', 'refs' => [ 'DataFieldSeriesItem$Settings' => '

The options that determine the presentation of line series associated to the field.

', 'FieldSeriesItem$Settings' => '

The options that determine the presentation of line series associated to the field.

', ], ], 'LineChartSortConfiguration' => [ 'base' => '

The sort configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$SortConfiguration' => '

The sort configuration of a line chart.

', ], ], 'LineChartType' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$Type' => '

Determines the type of the line chart.

', ], ], 'LineChartVisual' => [ 'base' => '

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$LineChartVisual' => '

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

', ], ], 'LineInterpolation' => [ 'base' => NULL, 'refs' => [ 'LineChartLineStyleSettings$LineInterpolation' => '

Interpolation style for line series.

', ], ], 'LineSeriesAxisDisplayOptions' => [ 'base' => '

The series axis configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$PrimaryYAxisDisplayOptions' => '

The series axis configuration of a line chart.

', 'LineChartConfiguration$SecondaryYAxisDisplayOptions' => '

The series axis configuration of a line chart.

', ], ], 'LinkEntityArn' => [ 'base' => NULL, 'refs' => [ 'LinkEntityArnList$member' => NULL, ], ], 'LinkEntityArnList' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'Dashboard$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'UpdateDashboardLinksRequest$LinkEntities' => '

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'UpdateDashboardLinksResponse$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', ], ], 'LinkSharingConfiguration' => [ 'base' => '

A structure that contains the configuration of a shareable link to the dashboard.

', 'refs' => [ 'CreateDashboardRequest$LinkSharingConfiguration' => '

A structure that contains the permissions of a shareable link to the dashboard.

', 'DescribeDashboardPermissionsResponse$LinkSharingConfiguration' => '

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

', 'UpdateDashboardPermissionsResponse$LinkSharingConfiguration' => '

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

', ], ], 'ListAnalysesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalysesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultFilterListControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterListControl$DisplayOptions' => '

The display options of a control.

', 'ParameterListControl$DisplayOptions' => '

The display options of a control.

', ], ], 'ListControlSearchOptions' => [ 'base' => '

The configuration of the search options in a list control.

', 'refs' => [ 'ListControlDisplayOptions$SearchOptions' => '

The configuration of the search options in a list control.

', ], ], 'ListControlSelectAllOptions' => [ 'base' => '

The configuration of the Select all options in a list control.

', 'refs' => [ 'DropDownControlDisplayOptions$SelectAllOptions' => '

The configuration of the Select all options in a dropdown control.

', 'ListControlDisplayOptions$SelectAllOptions' => '

The configuration of the Select all options in a list control.

', ], ], 'ListDashboardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFolderMembersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFolderMembersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFoldersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFoldersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListIdentityPropagationConfigsRequest$MaxResults' => '

The maximum number of results to be returned.

', ], ], 'ListIngestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNamespacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListNamespacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRefreshSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRefreshSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRoleMembershipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoleMembershipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicRefreshSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicRefreshSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicReviewedAnswersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicReviewedAnswersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadingAnimation' => [ 'base' => '

The configuration of loading animation in free-form layout.

', 'refs' => [ 'FreeFormLayoutElement$LoadingAnimation' => '

The loading animation configuration of a free-form layout element.

', ], ], 'LocalNavigationConfiguration' => [ 'base' => '

The navigation configuration for CustomActionNavigationOperation.

', 'refs' => [ 'CustomActionNavigationOperation$LocalNavigationConfiguration' => '

The configuration that chooses the navigation target.

', ], ], 'LogicalTable' => [ 'base' => '

A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

', 'refs' => [ 'LogicalTableMap$value' => NULL, ], ], 'LogicalTableAlias' => [ 'base' => NULL, 'refs' => [ 'LogicalTable$Alias' => '

A display name for the logical table.

', ], ], 'LogicalTableId' => [ 'base' => '

An identifier for the logical table that is defined in the dataset

', 'refs' => [ 'JoinInstruction$LeftOperand' => '

The operand on the left side of a join.

', 'JoinInstruction$RightOperand' => '

The operand on the right side of a join.

', 'LogicalTableMap$key' => NULL, ], ], 'LogicalTableMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', 'DataSet$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', 'UpdateDataSetRequest$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', ], ], 'LogicalTableSource' => [ 'base' => '

Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'LogicalTable$Source' => '

Source of this logical table.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DataSet$ConsumedSpiceCapacityInBytes' => '

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn\'t imported into SPICE.

', 'Ingestion$IngestionTimeInSeconds' => '

The time that this ingestion took, measured in seconds.

', 'Ingestion$IngestionSizeInBytes' => '

The size of the data ingested, in bytes.

', 'ItemsLimitConfiguration$ItemsLimit' => '

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

', 'PaginationConfiguration$PageSize' => '

Indicates how many items render in one page.

', 'RowInfo$RowsIngested' => '

The number of rows that were ingested.

', 'RowInfo$RowsDropped' => '

The number of rows that were not ingested.

', 'RowInfo$TotalRowsInDataset' => '

The total number of rows in the dataset.

', ], ], 'LongFormatText' => [ 'base' => '

The text format for a subtitle.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualSubtitleLabelOptions$FormatText' => '

The long text format of the subtitle label, such as plain text or rich text.

', ], ], 'LongPlainText' => [ 'base' => NULL, 'refs' => [ 'LongFormatText$PlainText' => '

Plain text format.

', ], ], 'LongRichText' => [ 'base' => NULL, 'refs' => [ 'LongFormatText$RichText' => '

Rich text. Examples of rich text include bold, underline, and italics.

', ], ], 'Longitude' => [ 'base' => NULL, 'refs' => [ 'GeospatialCoordinateBounds$West' => '

The longitude of the west bound of the geospatial coordinate bounds.

', 'GeospatialCoordinateBounds$East' => '

The longitude of the east bound of the geospatial coordinate bounds.

', ], ], 'LookbackWindow' => [ 'base' => '

The lookback window setup of an incremental refresh configuration.

', 'refs' => [ 'IncrementalRefresh$LookbackWindow' => '

The lookback window setup for an incremental refresh configuration.

', ], ], 'LookbackWindowSizeUnit' => [ 'base' => NULL, 'refs' => [ 'LookbackWindow$SizeUnit' => '

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

', ], ], 'ManifestFileLocation' => [ 'base' => '

Amazon S3 manifest file location.

', 'refs' => [ 'S3Parameters$ManifestFileLocation' => '

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

', ], ], 'MapZoomMode' => [ 'base' => NULL, 'refs' => [ 'GeospatialWindowOptions$MapZoomMode' => '

The map zoom modes (manual, auto) of the geospatial window options.

', ], ], 'MappedDataSetParameter' => [ 'base' => '

A dataset parameter that is mapped to an analysis parameter.

', 'refs' => [ 'MappedDataSetParameters$member' => NULL, ], ], 'MappedDataSetParameters' => [ 'base' => '

A list of dataset parameters that are mapped to an analysis parameter.

', 'refs' => [ 'DateTimeParameterDeclaration$MappedDataSetParameters' => NULL, 'DecimalParameterDeclaration$MappedDataSetParameters' => NULL, 'IntegerParameterDeclaration$MappedDataSetParameters' => NULL, 'StringParameterDeclaration$MappedDataSetParameters' => NULL, ], ], 'MarginStyle' => [ 'base' => '

The display options for margins around the outside edge of sheets.

', 'refs' => [ 'TileLayoutStyle$Margin' => '

The margin settings that apply around the outside edge of sheets.

', ], ], 'MariaDbParameters' => [ 'base' => '

The parameters for MariaDB.

', 'refs' => [ 'DataSourceParameters$MariaDbParameters' => '

The parameters for MariaDB.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeFolderPermissionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'DescribeFolderResolvedPermissionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListAnalysesRequest$MaxResults' => '

The maximum number of results to return.

', 'ListAssetBundleExportJobsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListAssetBundleImportJobsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDashboardVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDashboardsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDataSetsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDataSourcesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListFolderMembersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListFoldersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListGroupMembershipsRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListGroupsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListIAMPolicyAssignmentsForUserRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListIAMPolicyAssignmentsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListNamespacesRequest$MaxResults' => '

The maximum number of results to return.

', 'ListRoleMembershipsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListTemplateAliasesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTemplateVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTemplatesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemeAliasesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemeVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTopicsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListUserGroupsRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListUsersRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListVPCConnectionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchAnalysesRequest$MaxResults' => '

The maximum number of results to return.

', 'SearchDashboardsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchDataSetsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchDataSourcesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchFoldersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchGroupsRequest$MaxResults' => '

The maximum number of results to return from this request.

', ], ], 'MaximumLabelType' => [ 'base' => '

The maximum label of a data path label.

', 'refs' => [ 'DataLabelType$MaximumLabelType' => '

Determines the label configuration for the maximum value in a visual.

', ], ], 'MaximumMinimumComputation' => [ 'base' => '

The maximum and minimum computation configuration.

', 'refs' => [ 'Computation$MaximumMinimum' => '

The maximum and minimum computation configuration.

', ], ], 'MaximumMinimumComputationType' => [ 'base' => NULL, 'refs' => [ 'MaximumMinimumComputation$Type' => '

The type of computation. Choose one of the following options:

', ], ], 'MeasureField' => [ 'base' => '

The measure (metric) type field.

', 'refs' => [ 'BoxPlotMeasureFieldList$member' => NULL, 'FilledMapMeasureFieldList$member' => NULL, 'ForecastComputation$Value' => '

The value field that is used in a computation.

', 'FunnelChartMeasureFieldList$member' => NULL, 'GrowthRateComputation$Value' => '

The value field that is used in a computation.

', 'HeatMapMeasureFieldList$member' => NULL, 'HistogramMeasureFieldList$member' => NULL, 'MaximumMinimumComputation$Value' => '

The value field that is used in a computation.

', 'MeasureFieldList$member' => NULL, 'MetricComparisonComputation$FromValue' => '

The field that is used in a metric comparison from value setup.

', 'MetricComparisonComputation$TargetValue' => '

The field that is used in a metric comparison to value setup.

', 'PeriodOverPeriodComputation$Value' => '

The value field that is used in a computation.

', 'PeriodToDateComputation$Value' => '

The value field that is used in a computation.

', 'PivotMeasureFieldList$member' => NULL, 'RadarChartValuesFieldList$member' => NULL, 'TopBottomMoversComputation$Value' => '

The value field that is used in a computation.

', 'TopBottomRankedComputation$Value' => '

The value field that is used in a computation.

', 'TotalAggregationComputation$Value' => '

The value field that is used in a computation.

', 'TreeMapMeasureFieldList$member' => NULL, 'WordCloudMeasureFieldList$member' => NULL, ], ], 'MeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$Values' => '

The value field wells of a bar chart. Values are aggregated by category.

', 'ComboChartAggregatedFieldWells$BarValues' => '

The aggregated BarValues field well of a combo chart.

', 'ComboChartAggregatedFieldWells$LineValues' => '

The aggregated LineValues field well of a combo chart.

', 'GaugeChartFieldWells$Values' => '

The value field wells of a GaugeChartVisual.

', 'GaugeChartFieldWells$TargetValues' => '

The target value field wells of a GaugeChartVisual.

', 'GeospatialMapAggregatedFieldWells$Values' => '

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

', 'KPIFieldWells$Values' => '

The value field wells of a KPI visual.

', 'KPIFieldWells$TargetValues' => '

The target value field wells of a KPI visual.

', 'LineChartAggregatedFieldWells$Values' => '

The value field wells of a line chart. Values are aggregated based on categories.

', 'PieChartAggregatedFieldWells$Values' => '

The value field wells of a pie chart. Values are aggregated based on categories.

', 'SankeyDiagramAggregatedFieldWells$Weight' => '

The weight field wells of a sankey diagram.

', 'ScatterPlotCategoricallyAggregatedFieldWells$XAxis' => '

The x-axis field well of a scatter plot.

The x-axis is aggregated by category.

', 'ScatterPlotCategoricallyAggregatedFieldWells$YAxis' => '

The y-axis field well of a scatter plot.

The y-axis is aggregated by category.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Size' => '

The size field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$Size' => '

The size field well of a scatter plot.

', 'TableAggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are aggregated based on group by fields.

', 'WaterfallChartAggregatedFieldWells$Values' => '

The value field wells of a waterfall visual.

', ], ], 'MemberIdArnPair' => [ 'base' => '

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

', 'refs' => [ 'FolderMemberList$member' => NULL, ], ], 'MemberType' => [ 'base' => NULL, 'refs' => [ 'CreateFolderMembershipRequest$MemberType' => '

The member type of the asset that you want to add to a folder.

', 'DeleteFolderMembershipRequest$MemberType' => '

The member type of the asset that you want to delete from a folder.

', 'FolderMember$MemberType' => '

The type of asset that it is.

', ], ], 'MetricComparisonComputation' => [ 'base' => '

The metric comparison computation configuration.

', 'refs' => [ 'Computation$MetricComparison' => '

The metric comparison computation configuration.

', ], ], 'MinimumLabelType' => [ 'base' => '

The minimum label of a data path label.

', 'refs' => [ 'DataLabelType$MinimumLabelType' => '

Determines the label configuration for the minimum value in a visual.

', ], ], 'MissingDataConfiguration' => [ 'base' => '

The configuration options that determine how missing data is treated during the rendering of a line chart.

', 'refs' => [ 'MissingDataConfigurationList$member' => NULL, ], ], 'MissingDataConfigurationList' => [ 'base' => NULL, 'refs' => [ 'LineSeriesAxisDisplayOptions$MissingDataConfigurations' => '

The configuration options that determine how missing data is treated during the rendering of a line chart.

', ], ], 'MissingDataTreatmentOption' => [ 'base' => NULL, 'refs' => [ 'MissingDataConfiguration$TreatmentOption' => '

The treatment option that determines how missing data should be rendered. Choose from the following options:

', ], ], 'MySqlParameters' => [ 'base' => '

The parameters for MySQL.

', 'refs' => [ 'DataSourceParameters$MySqlParameters' => '

The parameters for MySQL.

', ], ], 'NamedEntityAggType' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinitionMetric$Aggregation' => '

The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

', ], ], 'NamedEntityDefinition' => [ 'base' => '

A structure that represents a named entity.

', 'refs' => [ 'NamedEntityDefinitions$member' => NULL, ], ], 'NamedEntityDefinitionMetric' => [ 'base' => '

A structure that represents a metric.

', 'refs' => [ 'NamedEntityDefinition$Metric' => '

The definition of a metric.

', ], ], 'NamedEntityDefinitions' => [ 'base' => NULL, 'refs' => [ 'TopicNamedEntity$Definition' => '

The definition of a named entity.

', ], ], 'NamedEntityRef' => [ 'base' => '

The definition for a NamedEntityRef.

', 'refs' => [ 'TopicIRGroupBy$NamedEntity' => '

The named entity for the TopicIRGroupBy.

', 'TopicIRMetric$NamedEntity' => '

The named entity for the TopicIRMetric.

', ], ], 'NamedFilterAggType' => [ 'base' => NULL, 'refs' => [ 'TopicNumericEqualityFilter$Aggregation' => '

An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

', 'TopicNumericRangeFilter$Aggregation' => '

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

', ], ], 'NamedFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicFilter$FilterType' => '

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

', ], ], 'Namespace' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$DefaultNamespace' => '

The default Amazon QuickSight namespace for your Amazon Web Services account.

', 'CreateAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you want to add customizations to.

', 'CreateAccountCustomizationResponse$Namespace' => '

The namespace associated with the customization you\'re creating.

', 'CreateGroupMembershipRequest$Namespace' => '

The namespace that you want the user to be a part of.

', 'CreateGroupRequest$Namespace' => '

The namespace that you want the group to be a part of.

', 'CreateIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'CreateNamespaceRequest$Namespace' => '

The name that you want to use to describe the new namespace.

', 'CreateNamespaceResponse$Name' => '

The name of the new namespace that you created.

', 'CreateRoleMembershipRequest$Namespace' => '

The namespace that the role belongs to.

', 'DeleteAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you\'re deleting the customizations from.

', 'DeleteGroupMembershipRequest$Namespace' => '

The namespace of the group that you want to remove a user from.

', 'DeleteGroupRequest$Namespace' => '

The namespace of the group that you want to delete.

', 'DeleteIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'DeleteNamespaceRequest$Namespace' => '

The namespace that you want to delete.

', 'DeleteRoleCustomPermissionRequest$Namespace' => '

The namespace that includes the role.

', 'DeleteRoleMembershipRequest$Namespace' => '

The namespace that contains the role.

', 'DeleteUserByPrincipalIdRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'DeleteUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'DescribeAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

', 'DescribeAccountCustomizationResponse$Namespace' => '

The Amazon QuickSight namespace that you\'re describing.

', 'DescribeFolderPermissionsRequest$Namespace' => '

The namespace of the folder whose permissions you want described.

', 'DescribeFolderResolvedPermissionsRequest$Namespace' => '

The namespace of the folder whose permissions you want described.

', 'DescribeGroupMembershipRequest$Namespace' => '

The namespace that includes the group you are searching within.

', 'DescribeGroupRequest$Namespace' => '

The namespace of the group that you want described.

', 'DescribeIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'DescribeNamespaceRequest$Namespace' => '

The namespace that you want to describe.

', 'DescribeRoleCustomPermissionRequest$Namespace' => '

The namespace that contains the role.

', 'DescribeUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'GenerateEmbedUrlForAnonymousUserRequest$Namespace' => '

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.

', 'GetDashboardEmbedUrlRequest$Namespace' => '

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you\'re not using a custom namespace, set Namespace = default.

', 'ListGroupMembershipsRequest$Namespace' => '

The namespace of the group that you want a list of users from.

', 'ListGroupsRequest$Namespace' => '

The namespace that you want a list of groups from.

', 'ListIAMPolicyAssignmentsForUserRequest$Namespace' => '

The namespace of the assignment.

', 'ListIAMPolicyAssignmentsRequest$Namespace' => '

The namespace for the assignments.

', 'ListRoleMembershipsRequest$Namespace' => '

The namespace that includes the role.

', 'ListUserGroupsRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'ListUsersRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'NamespaceInfoV2$Name' => '

The name of the error.

', 'RegisterUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'RowLevelPermissionDataSet$Namespace' => '

The namespace associated with the dataset that contains permissions for RLS.

', 'SearchGroupsRequest$Namespace' => '

The namespace that you want to search.

', 'UpdateAccountCustomizationRequest$Namespace' => '

The namespace that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountCustomizationResponse$Namespace' => '

The namespace associated with the customization that you\'re updating.

', 'UpdateAccountSettingsRequest$DefaultNamespace' => '

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.

', 'UpdateGroupRequest$Namespace' => '

The namespace of the group that you want to update.

', 'UpdateIAMPolicyAssignmentRequest$Namespace' => '

The namespace of the assignment.

', 'UpdateRoleCustomPermissionRequest$Namespace' => '

The namespace that contains the role that you want to update.

', 'UpdateUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', ], ], 'NamespaceError' => [ 'base' => '

Errors that occur during namespace creation.

', 'refs' => [ 'NamespaceInfoV2$NamespaceError' => '

An error that occurred when the namespace was created.

', ], ], 'NamespaceErrorType' => [ 'base' => NULL, 'refs' => [ 'NamespaceError$Type' => '

The error type.

', ], ], 'NamespaceInfoV2' => [ 'base' => '

The error type.

', 'refs' => [ 'DescribeNamespaceResponse$Namespace' => '

The information about the namespace that you\'re describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

', 'Namespaces$member' => NULL, ], ], 'NamespaceStatus' => [ 'base' => NULL, 'refs' => [ 'CreateNamespaceResponse$CreationStatus' => '

The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

', 'NamespaceInfoV2$CreationStatus' => '

The creation status of a namespace that is not yet completely created.

', ], ], 'Namespaces' => [ 'base' => NULL, 'refs' => [ 'ListNamespacesResponse$Namespaces' => '

The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.

', ], ], 'NarrativeString' => [ 'base' => NULL, 'refs' => [ 'CustomNarrativeOptions$Narrative' => '

The string input of custom narrative.

', ], ], 'NegativeFormat' => [ 'base' => '

A structure that represents a negative format.

', 'refs' => [ 'DisplayFormatOptions$NegativeFormat' => '

The negative format.

', ], ], 'NegativeValueConfiguration' => [ 'base' => '

The options that determine the negative value configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', 'NumberDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', 'PercentageDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', ], ], 'NegativeValueDisplayMode' => [ 'base' => NULL, 'refs' => [ 'NegativeValueConfiguration$DisplayMode' => '

Determines the display mode of the negative value configuration.

', ], ], 'NestedFilter' => [ 'base' => '

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

', 'refs' => [ 'Filter$NestedFilter' => '

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

', ], ], 'NetworkInterface' => [ 'base' => '

The structure that contains information about a network interface.

', 'refs' => [ 'NetworkInterfaceList$member' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$NetworkInterfaceId' => '

The network interface ID.

', ], ], 'NetworkInterfaceList' => [ 'base' => NULL, 'refs' => [ 'VPCConnection$NetworkInterfaces' => '

A list of network interfaces.

', 'VPCConnectionSummary$NetworkInterfaces' => '

A list of network interfaces.

', ], ], 'NetworkInterfaceStatus' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$Status' => '

The status of the network interface.

', ], ], 'NewDefaultValues' => [ 'base' => '

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

', 'refs' => [ 'OverrideDatasetParameterOperation$NewDefaultValues' => '

The new default values for the parameter.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$Message' => '

The message associated with the analysis error.

', 'AssetBundleExportJobError$Type' => '

The specific error type of the error that occurred.

', 'AssetBundleExportJobError$Message' => '

A description of the error.

', 'AssetBundleExportJobWarning$Message' => '

A description of the warning.

', 'AssetBundleImportJobError$Type' => '

The specific error type or the error that occurred.

', 'AssetBundleImportJobError$Message' => '

A description of the error.

', 'AssetBundleImportJobWarning$Message' => '

A description of the warning that occurred during an Asset Bundle import job.

', 'DashboardError$Message' => '

Message.

', 'DataSetReference$DataSetPlaceholder' => '

Dataset placeholder.

', 'DateTimeParameter$Name' => '

A display name for the date-time parameter.

', 'DecimalParameter$Name' => '

A display name for the decimal parameter.

', 'DescribeAssetBundleExportJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAssetBundleImportJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardSnapshotJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardSnapshotJobResultResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeKeyRegistrationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'Entity$Path' => '

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

', 'FailedKeyRegistrationEntry$Message' => '

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

', 'IntegerParameter$Name' => '

The name of the integer parameter.

', 'ListAssetBundleExportJobsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListAssetBundleImportJobsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ReferenceLineCustomLabelConfiguration$CustomLabel' => '

The string text of the custom label.

', 'S3BucketConfiguration$BucketName' => '

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

', 'S3BucketConfiguration$BucketPrefix' => '

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

', 'S3BucketConfiguration$BucketRegion' => '

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.

', 'StartAssetBundleExportJobResponse$RequestId' => '

The Amazon Web Services response ID for this operation.

', 'StartAssetBundleImportJobResponse$RequestId' => '

The Amazon Web Services response ID for this operation.

', 'StartDashboardSnapshotJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'StringParameter$Name' => '

A display name for a string parameter.

', 'TemplateError$Message' => '

Description of the error type.

', 'ThemeError$Message' => '

The error message.

', 'UpdateKeyRegistrationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', ], ], 'NonRepeatingVisualsList' => [ 'base' => NULL, 'refs' => [ 'BodySectionRepeatConfiguration$NonRepeatingVisuals' => '

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

', ], ], 'NullFilterOption' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$NullFilter' => '

The null filter for the TopicIRFilterOption.

', ], ], 'NullString' => [ 'base' => NULL, 'refs' => [ 'NullValueFormatConfiguration$NullString' => '

Determines the null string of null values.

', ], ], 'NullValueFormatConfiguration' => [ 'base' => '

The options that determine the null value format configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'DateTimeFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'NumberDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'PercentageDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'StringFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$Enabled' => '

A value that specifies whether IP rules are turned on.

', 'TopicCalculatedField$DisableIndexing' => '

A Boolean value that indicates if a calculated field is visible in the autocomplete.

', 'TopicCalculatedField$NonAdditive' => '

The non additive for the table style target.

', 'TopicColumn$DisableIndexing' => '

A Boolean value that indicates whether the column shows in the autocomplete functionality.

', 'TopicColumn$NonAdditive' => '

The non additive value for the column.

', 'TopicRefreshSchedule$IsEnabled' => '

A Boolean value that controls whether to schedule is enabled.

', 'UpdateIpRestrictionRequest$Enabled' => '

A value that specifies whether IP rules are turned on.

', ], ], 'NumberDisplayFormatConfiguration' => [ 'base' => '

The options that determine the number display format configuration.

', 'refs' => [ 'ComparisonFormatConfiguration$NumberDisplayFormatConfiguration' => '

The number display format.

', 'NumericFormatConfiguration$NumberDisplayFormatConfiguration' => '

The options that determine the number display format configuration.

', ], ], 'NumberFormatConfiguration' => [ 'base' => '

Formatting configuration for number fields.

', 'refs' => [ 'FormatConfiguration$NumberFormatConfiguration' => '

Formatting configuration for number fields.

', 'NumericalDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'NumericalMeasureField$FormatConfiguration' => '

The format configuration of the field.

', ], ], 'NumberScale' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$NumberScale' => '

Determines the number scale value for the currency format.

', 'DisplayFormatOptions$UnitScaler' => '

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

', 'NumberDisplayFormatConfiguration$NumberScale' => '

Determines the number scale value of the number format.

', ], ], 'NumericAxisOptions' => [ 'base' => '

The options for an axis with a numeric field.

', 'refs' => [ 'AxisDataOptions$NumericAxisOptions' => '

The options for an axis with a numeric field.

', ], ], 'NumericEqualityDrillDownFilter' => [ 'base' => '

The numeric equality type drill down filter.

', 'refs' => [ 'DrillDownFilter$NumericEqualityFilter' => '

The numeric equality type drill down filter. This filter is used for number type columns.

', ], ], 'NumericEqualityFilter' => [ 'base' => '

A NumericEqualityFilter filters values that are equal to the specified value.

', 'refs' => [ 'Filter$NumericEqualityFilter' => '

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

', ], ], 'NumericEqualityMatchOperator' => [ 'base' => NULL, 'refs' => [ 'NumericEqualityFilter$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', ], ], 'NumericFilterSelectAllOptions' => [ 'base' => NULL, 'refs' => [ 'NumericEqualityFilter$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'NumericRangeFilter$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', ], ], 'NumericFormatConfiguration' => [ 'base' => '

The options that determine the numeric format configuration.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DateTimeFormatConfiguration$NumericFormatConfiguration' => '

The formatting configuration for numeric DateTime fields.

', 'NumberFormatConfiguration$FormatConfiguration' => '

The options that determine the numeric format configuration.

', 'ReferenceLineValueLabelConfiguration$FormatConfiguration' => '

The format configuration of the value label.

', 'StringFormatConfiguration$NumericFormatConfiguration' => '

The formatting configuration for numeric strings.

', ], ], 'NumericRangeFilter' => [ 'base' => '

A NumericRangeFilter filters values that are within the value range.

', 'refs' => [ 'Filter$NumericRangeFilter' => '

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

', ], ], 'NumericRangeFilterValue' => [ 'base' => '

The value input pf the numeric range filter.

', 'refs' => [ 'NumericRangeFilter$RangeMinimum' => '

The minimum value for the filter value range.

', 'NumericRangeFilter$RangeMaximum' => '

The maximum value for the filter value range.

', ], ], 'NumericSeparatorConfiguration' => [ 'base' => '

The options that determine the numeric separator configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', 'NumberDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', 'PercentageDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', ], ], 'NumericSeparatorSymbol' => [ 'base' => NULL, 'refs' => [ 'NumericSeparatorConfiguration$DecimalSeparator' => '

Determines the decimal separator.

', 'ThousandSeparatorOptions$Symbol' => '

Determines the thousands separator symbol.

', ], ], 'NumericalAggregationFunction' => [ 'base' => '

Aggregation for numerical values.

', 'refs' => [ 'AggregationFunction$NumericalAggregationFunction' => '

Aggregation for numerical values.

', 'NumericalMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', 'ReferenceLineDynamicDataConfiguration$Calculation' => '

The calculation that is used in the dynamic data.

', ], ], 'NumericalDimensionField' => [ 'base' => '

The dimension type field with numerical type columns.

', 'refs' => [ 'DimensionField$NumericalDimensionField' => '

The dimension type field with numerical type columns.

', ], ], 'NumericalMeasureField' => [ 'base' => '

The measure type field with numerical type columns.

', 'refs' => [ 'MeasureField$NumericalMeasureField' => '

The measure type field with numerical type columns.

', ], ], 'OnClause' => [ 'base' => NULL, 'refs' => [ 'JoinInstruction$OnClause' => '

The join instructions provided in the ON clause of a join.

', ], ], 'OperandList' => [ 'base' => NULL, 'refs' => [ 'TopicIRMetric$Operands' => '

The operands for the TopicIRMetric.

', ], ], 'OptionalPort' => [ 'base' => NULL, 'refs' => [ 'RedshiftParameters$Port' => '

Port. This field can be blank if the ClusterId is provided.

', ], ], 'OracleParameters' => [ 'base' => '

The parameters for Oracle.

', 'refs' => [ 'DataSourceParameters$OracleParameters' => '

The parameters for Oracle.

', ], ], 'OtherCategories' => [ 'base' => NULL, 'refs' => [ 'ItemsLimitConfiguration$OtherCategories' => '

The Show other of an axis in the chart. Choose one of the following options:

', ], ], 'OutputColumn' => [ 'base' => '

Output column.

', 'refs' => [ 'OutputColumnList$member' => NULL, ], ], 'OutputColumnList' => [ 'base' => NULL, 'refs' => [ 'DataSet$OutputColumns' => '

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

', ], ], 'OverrideDatasetParameterOperation' => [ 'base' => '

A transform operation that overrides the dataset parameter values that are defined in another dataset.

', 'refs' => [ 'TransformOperation$OverrideDatasetParameterOperation' => NULL, ], ], 'PageNumber' => [ 'base' => NULL, 'refs' => [ 'PaginationConfiguration$PageNumber' => '

Indicates the page number.

', ], ], 'PaginationConfiguration' => [ 'base' => '

The pagination configuration for a table visual or boxplot.

', 'refs' => [ 'BoxPlotSortConfiguration$PaginationConfiguration' => '

The pagination configuration of a table visual or box plot.

', 'TableSortConfiguration$PaginationConfiguration' => '

The pagination configuration (page size, page number) for the table.

', ], ], 'PanelBorderStyle' => [ 'base' => NULL, 'refs' => [ 'PanelConfiguration$BorderStyle' => '

Sets the line style of panel borders.

', ], ], 'PanelConfiguration' => [ 'base' => '

A collection of options that configure how each panel displays in a small multiples chart.

', 'refs' => [ 'SmallMultiplesOptions$PanelConfiguration' => '

Configures the display options for each small multiples panel.

', ], ], 'PanelTitleOptions' => [ 'base' => '

The options that determine the title styles for each small multiples panel.

', 'refs' => [ 'PanelConfiguration$Title' => '

Configures the title display within each small multiples panel.

', ], ], 'PaperOrientation' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperOrientation' => '

The paper orientation that is used to define canvas dimensions. Choose one of the following options:

', ], ], 'PaperSize' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperSize' => '

The paper size that is used to define canvas dimensions.

', ], ], 'ParameterControl' => [ 'base' => '

The control of a parameter that users can interact with in a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ParameterControlList$member' => NULL, ], ], 'ParameterControlList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$ParameterControls' => '

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

', ], ], 'ParameterDateTimePickerControl' => [ 'base' => '

A control from a date parameter that specifies date and time.

', 'refs' => [ 'ParameterControl$DateTimePicker' => '

A control from a date parameter that specifies date and time.

', ], ], 'ParameterDeclaration' => [ 'base' => '

The declaration definition of a parameter.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ParameterDeclarationList$member' => NULL, ], ], 'ParameterDeclarationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$ParameterDeclarations' => '

An array of parameter declarations for an analysis.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'DashboardVersionDefinition$ParameterDeclarations' => '

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'TemplateVersionDefinition$ParameterDeclarations' => '

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', ], ], 'ParameterDropDownControl' => [ 'base' => '

A control to display a dropdown list with buttons that are used to select a single value.

', 'refs' => [ 'ParameterControl$Dropdown' => '

A control to display a dropdown list with buttons that are used to select a single value.

', ], ], 'ParameterListControl' => [ 'base' => '

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

', 'refs' => [ 'ParameterControl$List' => '

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'AnchorDateConfiguration$ParameterName' => '

The name of the parameter that is used for the anchor date configuration.

', 'CustomFilterConfiguration$ParameterName' => '

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue.

', 'DateTimeParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'DecimalParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'IntegerParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'MappedDataSetParameter$DataSetParameterName' => '

The name of the dataset parameter.

', 'NumericEqualityFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', 'NumericRangeFilterValue$Parameter' => '

The parameter that is used in the numeric range.

', 'ParameterDateTimePickerControl$SourceParameterName' => '

The name of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$SourceParameterName' => '

The source parameter name of the ParameterDropDownControl.

', 'ParameterListControl$SourceParameterName' => '

The source parameter name of the ParameterListControl.

', 'ParameterSliderControl$SourceParameterName' => '

The source parameter name of the ParameterSliderControl.

', 'ParameterTextAreaControl$SourceParameterName' => '

The source parameter name of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$SourceParameterName' => '

The source parameter name of the ParameterTextFieldControl.

', 'RelativeDatesFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', 'SetParameterValueConfiguration$DestinationParameterName' => '

The destination parameter name of the SetParameterValueConfiguration.

', 'StringParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'TimeEqualityFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value and RollingDate.

', 'TimeRangeFilterValue$Parameter' => '

The parameter type input value.

', 'TopBottomFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', ], ], 'ParameterSelectableValueList' => [ 'base' => NULL, 'refs' => [ 'FilterSelectableValues$Values' => '

The values that are used in the FilterSelectableValues.

', 'ParameterSelectableValues$Values' => '

The values that are used in ParameterSelectableValues.

', ], ], 'ParameterSelectableValues' => [ 'base' => '

A list of selectable values that are used in a control.

', 'refs' => [ 'ParameterDropDownControl$SelectableValues' => '

A list of selectable values that are used in a control.

', 'ParameterListControl$SelectableValues' => '

A list of selectable values that are used in a control.

', ], ], 'ParameterSliderControl' => [ 'base' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', 'refs' => [ 'ParameterControl$Slider' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', ], ], 'ParameterTextAreaControl' => [ 'base' => '

A control to display a text box that is used to enter multiple entries.

', 'refs' => [ 'ParameterControl$TextArea' => '

A control to display a text box that is used to enter multiple entries.

', ], ], 'ParameterTextFieldControl' => [ 'base' => '

A control to display a text box that is used to enter a single entry.

', 'refs' => [ 'ParameterControl$TextField' => '

A control to display a text box that is used to enter a single entry.

', ], ], 'ParameterValueType' => [ 'base' => NULL, 'refs' => [ 'DecimalParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', 'IntegerParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', 'StringParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', ], ], 'Parameters' => [ 'base' => '

A list of Amazon QuickSight parameters and the list\'s override values.

', 'refs' => [ 'CreateAnalysisRequest$Parameters' => '

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

', 'CreateDashboardRequest$Parameters' => '

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

', 'SnapshotConfiguration$Parameters' => NULL, 'UpdateAnalysisRequest$Parameters' => '

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

', 'UpdateDashboardRequest$Parameters' => '

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentialPair$Password' => '

The password for the data source connection.

', 'CredentialPair$Password' => '

Password.

', ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'Folder$FolderPath' => '

An array of ancestor ARN strings for the folder.

', ], ], 'PercentNumber' => [ 'base' => NULL, 'refs' => [ 'PercentVisibleRange$From' => '

The lower bound of the range.

', 'PercentVisibleRange$To' => '

The top bound of the range.

', ], ], 'PercentVisibleRange' => [ 'base' => '

The percent range in the visible range.

', 'refs' => [ 'VisibleRangeOptions$PercentRange' => '

The percent range in the visible range.

', ], ], 'PercentageDisplayFormatConfiguration' => [ 'base' => '

The options that determine the percentage display format configuration.

', 'refs' => [ 'ComparisonFormatConfiguration$PercentageDisplayFormatConfiguration' => '

The percentage display format.

', 'NumericFormatConfiguration$PercentageDisplayFormatConfiguration' => '

The options that determine the percentage display format configuration.

', ], ], 'PercentileAggregation' => [ 'base' => '

An aggregation based on the percentile of values in a dimension or measure.

', 'refs' => [ 'NumericalAggregationFunction$PercentileAggregation' => '

An aggregation based on the percentile of values in a dimension or measure.

', ], ], 'PercentileValue' => [ 'base' => NULL, 'refs' => [ 'PercentileAggregation$PercentileValue' => '

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

', ], ], 'PeriodOverPeriodComputation' => [ 'base' => '

The period over period computation configuration.

', 'refs' => [ 'Computation$PeriodOverPeriod' => '

The period over period computation configuration.

', ], ], 'PeriodToDateComputation' => [ 'base' => '

The period to date computation configuration.

', 'refs' => [ 'Computation$PeriodToDate' => '

The period to DataSetIdentifier computation configuration.

', ], ], 'PeriodsBackward' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PeriodsBackward' => '

The periods backward setup of a forecast computation.

', 'TimeBasedForecastProperties$PeriodsBackward' => '

The periods backward setup of a forecast computation.

', ], ], 'PeriodsForward' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PeriodsForward' => '

The periods forward setup of a forecast computation.

', 'TimeBasedForecastProperties$PeriodsForward' => '

The periods forward setup of a forecast computation.

', ], ], 'PhysicalTable' => [ 'base' => '

A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'PhysicalTableMap$value' => NULL, ], ], 'PhysicalTableId' => [ 'base' => NULL, 'refs' => [ 'LogicalTableSource$PhysicalTableId' => '

Physical table ID.

', 'PhysicalTableMap$key' => NULL, ], ], 'PhysicalTableMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', 'DataSet$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', 'UpdateDataSetRequest$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', ], ], 'PieChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a pie chart.

', 'refs' => [ 'PieChartFieldWells$PieChartAggregatedFieldWells' => '

The field well configuration of a pie chart.

', ], ], 'PieChartConfiguration' => [ 'base' => '

The configuration of a pie chart.

', 'refs' => [ 'PieChartVisual$ChartConfiguration' => '

The configuration of a pie chart.

', ], ], 'PieChartFieldWells' => [ 'base' => '

The field well configuration of a pie chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'PieChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'PieChartSortConfiguration' => [ 'base' => '

The sort configuration of a pie chart.

', 'refs' => [ 'PieChartConfiguration$SortConfiguration' => '

The sort configuration of a pie chart.

', ], ], 'PieChartVisual' => [ 'base' => '

A pie or donut chart.

The PieChartVisual structure describes a visual that is a member of the pie chart family.

The following charts can be described by using this structure:

For more information, see Using pie charts in the Amazon QuickSight User Guide.

For more information, see Using donut charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$PieChartVisual' => '

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

', ], ], 'PivotFieldSortOptions' => [ 'base' => '

The field sort options for a pivot table sort configuration.

', 'refs' => [ 'PivotFieldSortOptionsList$member' => NULL, ], ], 'PivotFieldSortOptionsList' => [ 'base' => NULL, 'refs' => [ 'PivotTableSortConfiguration$FieldSortOptions' => '

The field sort options for a pivot table sort configuration.

', ], ], 'PivotMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'PivotTableAggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

', ], ], 'PivotTableAggregatedFieldWells' => [ 'base' => '

The aggregated field well for the pivot table.

', 'refs' => [ 'PivotTableFieldWells$PivotTableAggregatedFieldWells' => '

The aggregated field well for the pivot table.

', ], ], 'PivotTableCellConditionalFormatting' => [ 'base' => '

The cell conditional formatting option for a pivot table.

', 'refs' => [ 'PivotTableConditionalFormattingOption$Cell' => '

The cell conditional formatting option for a pivot table.

', ], ], 'PivotTableConditionalFormatting' => [ 'base' => '

The conditional formatting for a PivotTableVisual.

', 'refs' => [ 'PivotTableVisual$ConditionalFormatting' => '

The conditional formatting for a PivotTableVisual.

', ], ], 'PivotTableConditionalFormattingOption' => [ 'base' => '

Conditional formatting options for a PivotTableVisual.

', 'refs' => [ 'PivotTableConditionalFormattingOptionList$member' => NULL, ], ], 'PivotTableConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options for a PivotTableVisual.

', ], ], 'PivotTableConditionalFormattingScope' => [ 'base' => '

The scope of the cell for conditional formatting.

', 'refs' => [ 'PivotTableCellConditionalFormatting$Scope' => '

The scope of the cell for conditional formatting.

', 'PivotTableConditionalFormattingScopeList$member' => NULL, ], ], 'PivotTableConditionalFormattingScopeList' => [ 'base' => NULL, 'refs' => [ 'PivotTableCellConditionalFormatting$Scopes' => '

A list of cell scopes for conditional formatting.

', ], ], 'PivotTableConditionalFormattingScopeRole' => [ 'base' => NULL, 'refs' => [ 'PivotTableConditionalFormattingScope$Role' => '

The role (field, field total, grand total) of the cell for conditional formatting.

', ], ], 'PivotTableConfiguration' => [ 'base' => '

The configuration for a PivotTableVisual.

', 'refs' => [ 'PivotTableVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'PivotTableDataPathOption' => [ 'base' => '

The data path options for the pivot table field options.

', 'refs' => [ 'PivotTableDataPathOptionList$member' => NULL, ], ], 'PivotTableDataPathOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$DataPathOptions' => '

The data path options for the pivot table field options.

', ], ], 'PivotTableDataPathType' => [ 'base' => NULL, 'refs' => [ 'DataPathType$PivotTableDataPathType' => '

The type of data path value utilized in a pivot table. Choose one of the following options:

', ], ], 'PivotTableDimensionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableAggregatedFieldWells$Rows' => '

The rows field well for a pivot table. Values are grouped by rows fields.

', 'PivotTableAggregatedFieldWells$Columns' => '

The columns field well for a pivot table. Values are grouped by columns fields.

', ], ], 'PivotTableFieldCollapseState' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldCollapseStateOption$State' => '

The state of the field target of a pivot table. Choose one of the following options:

', ], ], 'PivotTableFieldCollapseStateOption' => [ 'base' => '

The collapse state options for the pivot table field options.

', 'refs' => [ 'PivotTableFieldCollapseStateOptionList$member' => NULL, ], ], 'PivotTableFieldCollapseStateOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$CollapseStateOptions' => '

The collapse state options for the pivot table field options.

', ], ], 'PivotTableFieldCollapseStateTarget' => [ 'base' => '

The target of a pivot table field collapse state.

', 'refs' => [ 'PivotTableFieldCollapseStateOption$Target' => '

A tagged-union object that sets the collapse state.

', ], ], 'PivotTableFieldOption' => [ 'base' => '

The selected field options for the pivot table field options.

', 'refs' => [ 'PivotTableFieldOptionList$member' => NULL, ], ], 'PivotTableFieldOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$SelectedFieldOptions' => '

The selected field options for the pivot table field options.

', ], ], 'PivotTableFieldOptions' => [ 'base' => '

The field options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$FieldOptions' => '

The field options for a pivot table visual.

', ], ], 'PivotTableFieldSubtotalOptions' => [ 'base' => '

The optional configuration of subtotals cells.

', 'refs' => [ 'PivotTableFieldSubtotalOptionsList$member' => NULL, ], ], 'PivotTableFieldSubtotalOptionsList' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$FieldLevelOptions' => '

The optional configuration of subtotal cells.

', ], ], 'PivotTableFieldWells' => [ 'base' => '

The field wells for a pivot table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'PivotTableConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'PivotTableMetricPlacement' => [ 'base' => NULL, 'refs' => [ 'PivotTableOptions$MetricPlacement' => '

The metric placement (row, column) options.

', ], ], 'PivotTableOptions' => [ 'base' => '

The table options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$TableOptions' => '

The table options for a pivot table visual.

', ], ], 'PivotTablePaginatedReportOptions' => [ 'base' => '

The paginated report options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$PaginatedReportOptions' => '

The paginated report options for a pivot table visual.

', ], ], 'PivotTableRowsLabelOptions' => [ 'base' => '

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

', 'refs' => [ 'PivotTableOptions$RowsLabelOptions' => '

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

', ], ], 'PivotTableRowsLabelText' => [ 'base' => NULL, 'refs' => [ 'PivotTableRowsLabelOptions$CustomLabel' => '

The custom label string for the rows label.

', ], ], 'PivotTableRowsLayout' => [ 'base' => NULL, 'refs' => [ 'PivotTableOptions$RowsLayout' => '

The layout for the row dimension headers of a pivot table. Choose one of the following options.

', ], ], 'PivotTableSortBy' => [ 'base' => '

The sort by field for the field sort options.

', 'refs' => [ 'PivotFieldSortOptions$SortBy' => '

The sort by field for the field sort options.

', ], ], 'PivotTableSortConfiguration' => [ 'base' => '

The sort configuration for a PivotTableVisual.

', 'refs' => [ 'PivotTableConfiguration$SortConfiguration' => '

The sort configuration for a PivotTableVisual.

', ], ], 'PivotTableSubtotalLevel' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$FieldLevel' => '

The field level (all, custom, last) for the subtotal cells.

', ], ], 'PivotTableTotalOptions' => [ 'base' => '

The total options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$TotalOptions' => '

The total options for a pivot table visual.

', ], ], 'PivotTableVisual' => [ 'base' => '

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$PivotTableVisual' => '

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

', ], ], 'PivotTotalOptions' => [ 'base' => '

The optional configuration of totals cells in a PivotTableVisual.

', 'refs' => [ 'PivotTableTotalOptions$RowTotalOptions' => '

The row total options.

', 'PivotTableTotalOptions$ColumnTotalOptions' => '

The column total options.

', ], ], 'PixelLength' => [ 'base' => 'String based length that is composed of value and unit in px', 'refs' => [ 'AxisDisplayOptions$AxisOffset' => '

The offset value that determines the starting placement of the axis within a visual\'s bounds.

', 'FreeFormLayoutElement$XAxisLocation' => '

The x-axis coordinate of the element.

', 'FreeFormLayoutElement$Width' => '

The width of an element within a free-form layout.

', 'FreeFormLayoutElement$Height' => '

The height of an element within a free-form layout.

', 'FreeFormLayoutScreenCanvasSizeOptions$OptimizedViewPortWidth' => '

The width that the view port will be optimized for when the layout renders.

', 'GridLayoutScreenCanvasSizeOptions$OptimizedViewPortWidth' => '

The width that the view port will be optimized for when the layout renders.

', 'LegendOptions$Width' => '

The width of the legend. If this value is omitted, a default width is used when rendering.

', 'LegendOptions$Height' => '

The height of the legend. If this value is omitted, a default height is used when rendering.

', 'LineChartLineStyleSettings$LineWidth' => '

Width that determines the line thickness.

', 'LineChartMarkerStyleSettings$MarkerSize' => '

Size of marker in the series.

', 'PanelConfiguration$BorderThickness' => '

Sets the line thickness of panel borders.

', 'PanelConfiguration$GutterSpacing' => '

Sets the total amount of negative space to display between sibling panels.

', 'PivotTableDataPathOption$Width' => '

The width of the data path option.

', 'PivotTableOptions$DefaultCellWidth' => '

The default cell width of the pivot table.

', 'SectionStyle$Height' => '

The height of a section.

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

', 'TableFieldOption$Width' => '

The width for a table field.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Port' => '

Port.

', 'AuroraPostgreSqlParameters$Port' => '

The port that Amazon Aurora PostgreSQL is listening on.

', 'DatabricksParameters$Port' => '

The port for the Databricks data source.

', 'ExasolParameters$Port' => '

The port for the Exasol data source.

', 'MariaDbParameters$Port' => '

Port.

', 'MySqlParameters$Port' => '

Port.

', 'OracleParameters$Port' => '

The port.

', 'PostgreSqlParameters$Port' => '

Port.

', 'PrestoParameters$Port' => '

Port.

', 'SparkParameters$Port' => '

Port.

', 'SqlServerParameters$Port' => '

Port.

', 'StarburstParameters$Port' => '

The port for the Starburst data source.

', 'TeradataParameters$Port' => '

Port.

', 'TrinoParameters$Port' => '

The port for the Trino data source.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'TwitterParameters$MaxRows' => '

Maximum number of rows to query Twitter.

', 'UploadSettings$StartFromRow' => '

A row number to start reading data from.

', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'LookbackWindow$Size' => '

The lookback window column size.

', ], ], 'PostgreSqlParameters' => [ 'base' => '

The parameters for PostgreSQL.

', 'refs' => [ 'DataSourceParameters$PostgreSqlParameters' => '

The parameters for PostgreSQL.

', ], ], 'PreconditionNotMetException' => [ 'base' => '

One or more preconditions aren\'t met.

', 'refs' => [], ], 'PredefinedHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

', 'refs' => [ 'ColumnHierarchy$PredefinedHierarchy' => '

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

', ], ], 'PredefinedHierarchyColumnList' => [ 'base' => NULL, 'refs' => [ 'PredefinedHierarchy$Columns' => '

The list of columns that define the predefined hierarchy.

', ], ], 'PredictionInterval' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PredictionInterval' => '

The prediction interval setup of a forecast computation.

', 'TimeBasedForecastProperties$PredictionInterval' => '

The prediction interval setup of a forecast computation.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the currency format.

', 'NumberDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the number format.

', 'PercentageDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the percentage format.

', ], ], 'PrestoParameters' => [ 'base' => '

The parameters for Presto.

', 'refs' => [ 'DataSourceParameters$PrestoParameters' => '

The parameters for Presto.

', ], ], 'PrimaryValueDisplayType' => [ 'base' => NULL, 'refs' => [ 'GaugeChartOptions$PrimaryValueDisplayType' => '

The options that determine the primary value display type.

', 'KPIOptions$PrimaryValueDisplayType' => '

The options that determine the primary value display type.

', ], ], 'Principal' => [ 'base' => NULL, 'refs' => [ 'AssetBundlePrincipalList$member' => NULL, 'ResourcePermission$Principal' => '

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

', ], ], 'PrincipalList' => [ 'base' => NULL, 'refs' => [ 'ColumnLevelPermissionRule$Principals' => '

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

', ], ], 'ProgressBarOptions' => [ 'base' => '

The options that determine the presentation of the progress bar of a KPI visual.

', 'refs' => [ 'KPIOptions$ProgressBar' => '

The options that determine the presentation of the progress bar of a KPI visual.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'BigQueryParameters$ProjectId' => '

The Google Cloud Platform project ID where your datasource was created.

', ], ], 'ProjectOperation' => [ 'base' => '

A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.

', 'refs' => [ 'TransformOperation$ProjectOperation' => '

An operation that projects columns. Operations that come after a projection can only refer to projected columns.

', ], ], 'ProjectedColumnList' => [ 'base' => NULL, 'refs' => [ 'ProjectOperation$ProjectedColumns' => '

Projected columns.

', ], ], 'PropertyRole' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinition$PropertyRole' => '

The property role. Valid values for this structure are PRIMARY and ID.

', ], ], 'PropertyUsage' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinition$PropertyUsage' => '

The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

', ], ], 'PurchaseMode' => [ 'base' => NULL, 'refs' => [ 'UpdateSPICECapacityConfigurationRequest$PurchaseMode' => '

Determines how SPICE capacity can be purchased. The following options are available.

', ], ], 'PutDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Query' => [ 'base' => NULL, 'refs' => [ 'TwitterParameters$Query' => '

Twitter query string.

', ], ], 'QueryExecutionMode' => [ 'base' => NULL, 'refs' => [ 'QueryExecutionOptions$QueryExecutionMode' => '

A structure that describes the query execution mode.

', ], ], 'QueryExecutionOptions' => [ 'base' => '

A structure that describes the query execution options.

', 'refs' => [ 'AnalysisDefinition$QueryExecutionOptions' => NULL, 'TemplateVersionDefinition$QueryExecutionOptions' => NULL, ], ], 'QueueInfo' => [ 'base' => '

Information about a queued dataset SPICE ingestion.

', 'refs' => [ 'Ingestion$QueueInfo' => NULL, ], ], 'QuickSightUserNotFoundException' => [ 'base' => '

The user with the provided name isn\'t found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.

', 'refs' => [], ], 'RadarChartAggregatedFieldWells' => [ 'base' => '

The aggregated field well configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartFieldWells$RadarChartAggregatedFieldWells' => '

The aggregated field wells of a radar chart visual.

', ], ], 'RadarChartAreaStyleSettings' => [ 'base' => '

The configured style settings of a radar chart.

', 'refs' => [ 'RadarChartSeriesSettings$AreaStyleSettings' => '

The area style settings of a radar chart.

', ], ], 'RadarChartAxesRangeScale' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$AxesRangeScale' => '

The axis behavior options of a radar chart.

', ], ], 'RadarChartCategoryFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Category' => '

The aggregated field well categories of a radar chart.

', ], ], 'RadarChartColorFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Color' => '

The color that are assigned to the aggregated field wells of a radar chart.

', ], ], 'RadarChartConfiguration' => [ 'base' => '

The configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'RadarChartFieldWells' => [ 'base' => '

The field wells of a radar chart visual.

', 'refs' => [ 'RadarChartConfiguration$FieldWells' => '

The field well configuration of a RadarChartVisual.

', ], ], 'RadarChartSeriesSettings' => [ 'base' => '

The series settings of a radar chart.

', 'refs' => [ 'RadarChartConfiguration$BaseSeriesSettings' => '

The base sreies settings of a radar chart.

', ], ], 'RadarChartShape' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$Shape' => '

The shape of the radar chart.

', ], ], 'RadarChartSortConfiguration' => [ 'base' => '

The sort configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartConfiguration$SortConfiguration' => '

The sort configuration of a RadarChartVisual.

', ], ], 'RadarChartStartAngle' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$StartAngle' => '

The start angle of a radar chart\'s axis.

', ], ], 'RadarChartValuesFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Values' => '

The values that are assigned to the aggregated field wells of a radar chart.

', ], ], 'RadarChartVisual' => [ 'base' => '

A radar chart visual.

', 'refs' => [ 'Visual$RadarChartVisual' => '

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide.

', ], ], 'RangeConstant' => [ 'base' => '

A structure that represents a range constant.

', 'refs' => [ 'TopicRangeFilterConstant$RangeConstant' => '

The value of the constant that is used to specify the endpoints of a range filter.

', ], ], 'RangeEndsLabelType' => [ 'base' => '

The range ends label type of a data path label.

', 'refs' => [ 'DataLabelType$RangeEndsLabelType' => '

Determines the label configuration for range end value in a visual.

', ], ], 'RdsParameters' => [ 'base' => '

The parameters for Amazon RDS.

', 'refs' => [ 'DataSourceParameters$RdsParameters' => '

The parameters for Amazon RDS.

', ], ], 'RecoveryWindowInDays' => [ 'base' => NULL, 'refs' => [ 'DeleteAnalysisRequest$RecoveryWindowInDays' => '

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.

', ], ], 'RedshiftIAMParameters' => [ 'base' => '

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 .

', 'refs' => [ 'RedshiftParameters$IAMParameters' => '

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

', ], ], 'RedshiftParameters' => [ 'base' => '

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.

', 'refs' => [ 'DataSourceParameters$RedshiftParameters' => '

The parameters for Amazon Redshift.

', ], ], 'ReferenceLine' => [ 'base' => '

The reference line visual display options.

', 'refs' => [ 'ReferenceLineList$member' => NULL, ], ], 'ReferenceLineCustomLabelConfiguration' => [ 'base' => '

The configuration for a custom label on a ReferenceLine.

', 'refs' => [ 'ReferenceLineLabelConfiguration$CustomLabelConfiguration' => '

The custom label configuration of the label in a reference line.

', ], ], 'ReferenceLineDataConfiguration' => [ 'base' => '

The data configuration of the reference line.

', 'refs' => [ 'ReferenceLine$DataConfiguration' => '

The data configuration of the reference line.

', ], ], 'ReferenceLineDynamicDataConfiguration' => [ 'base' => '

The dynamic configuration of the reference line data configuration.

', 'refs' => [ 'ReferenceLineDataConfiguration$DynamicConfiguration' => '

The dynamic configuration of the reference line data configuration.

', ], ], 'ReferenceLineLabelConfiguration' => [ 'base' => '

The label configuration of a reference line.

', 'refs' => [ 'ReferenceLine$LabelConfiguration' => '

The label configuration of the reference line.

', ], ], 'ReferenceLineLabelHorizontalPosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineLabelConfiguration$HorizontalPosition' => '

The horizontal position configuration of the label in a reference line. Choose one of the following options:

', ], ], 'ReferenceLineLabelVerticalPosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineLabelConfiguration$VerticalPosition' => '

The vertical position configuration of the label in a reference line. Choose one of the following options:

', ], ], 'ReferenceLineList' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'BoxPlotChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'ComboChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'LineChartConfiguration$ReferenceLines' => '

The reference lines configuration of a line chart.

', ], ], 'ReferenceLinePatternType' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineStyleConfiguration$Pattern' => '

The pattern type of the line style. Choose one of the following options:

', ], ], 'ReferenceLineSeriesType' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineDataConfiguration$SeriesType' => '

The series type of the reference line data configuration. Choose one of the following options:

', ], ], 'ReferenceLineStaticDataConfiguration' => [ 'base' => '

The static data configuration of the reference line data configuration.

', 'refs' => [ 'ReferenceLineDataConfiguration$StaticConfiguration' => '

The static data configuration of the reference line data configuration.

', ], ], 'ReferenceLineStyleConfiguration' => [ 'base' => '

The style configuration of the reference line.

', 'refs' => [ 'ReferenceLine$StyleConfiguration' => '

The style configuration of the reference line.

', ], ], 'ReferenceLineValueLabelConfiguration' => [ 'base' => '

The value label configuration of the label in a reference line.

', 'refs' => [ 'ReferenceLineLabelConfiguration$ValueLabelConfiguration' => '

The value label configuration of the label in a reference line.

', ], ], 'ReferenceLineValueLabelRelativePosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineValueLabelConfiguration$RelativePosition' => '

The relative position of the value label. Choose one of the following options:

', ], ], 'RefreshConfiguration' => [ 'base' => '

The refresh configuration of a dataset.

', 'refs' => [ 'DataSetRefreshProperties$RefreshConfiguration' => '

The refresh configuration for a dataset.

', ], ], 'RefreshFrequency' => [ 'base' => '

Specifies the interval between each scheduled refresh of a dataset.

', 'refs' => [ 'RefreshSchedule$ScheduleFrequency' => '

The frequency for the refresh schedule.

', ], ], 'RefreshInterval' => [ 'base' => NULL, 'refs' => [ 'RefreshFrequency$Interval' => '

The interval between scheduled refreshes. Valid values are as follows:

', ], ], 'RefreshSchedule' => [ 'base' => '

The refresh schedule of a dataset.

', 'refs' => [ 'CreateRefreshScheduleRequest$Schedule' => '

The refresh schedule.

', 'DescribeRefreshScheduleResponse$RefreshSchedule' => '

The refresh schedule.

', 'RefreshSchedules$member' => '

A list of RefreshSchedule objects.

', 'UpdateRefreshScheduleRequest$Schedule' => '

The refresh schedule.

', ], ], 'RefreshSchedules' => [ 'base' => NULL, 'refs' => [ 'ListRefreshSchedulesResponse$RefreshSchedules' => '

The list of refresh schedules for the dataset.

', ], ], 'RegisterUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisteredCustomerManagedKey' => [ 'base' => '

A customer managed key structure that contains the information listed below:

', 'refs' => [ 'KeyRegistration$member' => NULL, ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'base' => '

The feature configurations of an embedded Amazon QuickSight console.

', 'refs' => [ 'RegisteredUserQuickSightConsoleEmbeddingConfiguration$FeatureConfigurations' => '

The embedding configuration of an embedded Amazon QuickSight console.

', ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'base' => '

Information about the dashboard you want to embed.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$Dashboard' => '

The configuration details for providing a dashboard embedding experience.

', ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'base' => '

The feature configuration for an embedded dashboard.

', 'refs' => [ 'RegisteredUserDashboardEmbeddingConfiguration$FeatureConfigurations' => '

The feature configurations of an embbedded Amazon QuickSight dashboard.

', ], ], 'RegisteredUserDashboardVisualEmbeddingConfiguration' => [ 'base' => '

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$DashboardVisual' => '

The type of embedding experience. In this case, Amazon QuickSight visuals.

', ], ], 'RegisteredUserEmbeddingExperienceConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'GenerateEmbedUrlForRegisteredUserRequest$ExperienceConfiguration' => '

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.

', ], ], 'RegisteredUserGenerativeQnAEmbeddingConfiguration' => [ 'base' => '

An object that provides information about the configuration of a Generative Q&A experience.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$GenerativeQnA' => '

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.

', ], ], 'RegisteredUserQSearchBarEmbeddingConfiguration' => [ 'base' => '

Information about the Q search bar embedding experience.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$QSearchBar' => '

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.

', ], ], 'RegisteredUserQuickSightConsoleEmbeddingConfiguration' => [ 'base' => '

Information about the Amazon QuickSight console that you want to embed.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$QuickSightConsole' => '

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.

', ], ], 'RelationalTable' => [ 'base' => '

A physical table type for relational data sources.

', 'refs' => [ 'PhysicalTable$RelationalTable' => '

A physical table type for relational data sources.

', ], ], 'RelationalTableCatalog' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Catalog' => '

The catalog associated with a table.

', ], ], 'RelationalTableName' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Name' => '

The name of the relational table.

', ], ], 'RelationalTableSchema' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Schema' => '

The schema name. This name applies to certain relational database engines.

', ], ], 'RelativeDateTimeControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultRelativeDateTimeControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterRelativeDateTimeControl$DisplayOptions' => '

The display options of a control.

', ], ], 'RelativeDateType' => [ 'base' => NULL, 'refs' => [ 'RelativeDatesFilter$RelativeDateType' => '

The range date type of the filter. Choose one of the options below:

', ], ], 'RelativeDatesFilter' => [ 'base' => '

A RelativeDatesFilter filters relative dates values.

', 'refs' => [ 'Filter$RelativeDatesFilter' => '

A RelativeDatesFilter filters date values that are relative to a given date.

', ], ], 'RelativeFontSize' => [ 'base' => NULL, 'refs' => [ 'FontSize$Relative' => '

The lexical name for the text size, proportional to its surrounding context.

', ], ], 'RenameColumnOperation' => [ 'base' => '

A transform operation that renames a column.

', 'refs' => [ 'TransformOperation$RenameColumnOperation' => '

An operation that renames a column.

', ], ], 'ResizeOption' => [ 'base' => NULL, 'refs' => [ 'GridLayoutScreenCanvasSizeOptions$ResizeOption' => '

This value determines the layout behavior when the viewport is resized.

', ], ], 'ResourceExistsException' => [ 'base' => '

The resource specified already exists.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParameters$AnalysisId' => '

The ID of the analysis that you ant to apply overrides to.

', 'AssetBundleImportJobDashboardOverrideParameters$DashboardId' => '

The ID of the dashboard that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverrideParameters$DataSetId' => '

The ID of the dataset to apply overrides to.

', 'AssetBundleImportJobDataSourceOverrideParameters$DataSourceId' => '

The ID of the data source to apply overrides to.

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$DataSetId' => '

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

', 'AssetBundleImportJobThemeOverrideParameters$ThemeId' => '

The ID of the theme to apply overrides to.

', 'CreateDataSetRequest$DataSetId' => '

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSetResponse$IngestionId' => '

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'CreateDataSourceRequest$DataSourceId' => '

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DataSet$DataSetId' => '

The ID of the dataset.

', 'DataSetSummary$DataSetId' => '

The ID of the dataset.

', 'DataSource$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DataSourceSummary$DataSourceId' => '

The unique ID of the data source.

', 'DeleteDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'DeleteDataSetRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeDataSetPermissionsRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSetPermissionsResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeDataSetRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourcePermissionsRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourcePermissionsResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeTopicRefreshRequest$RefreshId' => '

The ID of the refresh, which is performed when the topic is created or updated.

', 'ListRefreshSchedulesRequest$DataSetId' => '

The ID of the dataset.

', 'PutDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'TopicRefreshDetails$RefreshId' => '

The ID of the refresh, which occurs as a result of topic creation or topic update.

', 'UpdateDataSetPermissionsRequest$DataSetId' => '

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetPermissionsResponse$DataSetId' => '

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetRequest$DataSetId' => '

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetResponse$IngestionId' => '

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'UpdateDataSourcePermissionsRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourcePermissionsResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParameters$Name' => '

A new name for the analysis.

', 'AssetBundleImportJobDashboardOverrideParameters$Name' => '

A new name for the dashboard.

', 'AssetBundleImportJobDataSetOverrideParameters$Name' => '

A new name for the dataset.

', 'AssetBundleImportJobDataSourceOverrideParameters$Name' => '

A new name for the data source.

', 'AssetBundleImportJobThemeOverrideParameters$Name' => '

A new name for the theme.

', 'AssetBundleImportJobVPCConnectionOverrideParameters$Name' => '

A new name for the VPC connection.

', 'CreateDataSetRequest$Name' => '

The display name for the dataset.

', 'CreateDataSourceRequest$Name' => '

A display name for the data source.

', 'CreateVPCConnectionRequest$Name' => '

The display name for the VPC connection.

', 'DataSet$Name' => '

A display name for the dataset.

', 'DataSetSummary$Name' => '

A display name for the dataset.

', 'DataSource$Name' => '

A display name for the data source.

', 'DataSourceSummary$Name' => '

The name of the data source.

', 'TopicDetails$Name' => '

The name of the topic.

', 'TopicSummary$Name' => '

The name of the topic.

', 'UpdateDataSetRequest$Name' => '

The display name for the dataset.

', 'UpdateDataSourceRequest$Name' => '

A display name for the data source.

', 'UpdateVPCConnectionRequest$Name' => '

The display name for the VPC connection.

', 'VPCConnection$Name' => '

The display name for the VPC connection.

', 'VPCConnectionSummary$Name' => '

The display name for the VPC connection.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

One or more resources can\'t be found.

', 'refs' => [], ], 'ResourcePermission' => [ 'base' => '

Permission for the resource.

', 'refs' => [ 'ResourcePermissionList$member' => NULL, 'UpdateLinkPermissionList$member' => NULL, 'UpdateResourcePermissionList$member' => NULL, ], ], 'ResourcePermissionList' => [ 'base' => NULL, 'refs' => [ 'CreateAnalysisRequest$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

', 'CreateDashboardRequest$Permissions' => '

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

', 'CreateDataSetRequest$Permissions' => '

A list of resource permissions on the dataset.

', 'CreateDataSourceRequest$Permissions' => '

A list of resource permissions on the data source.

', 'CreateFolderRequest$Permissions' => '

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

', 'CreateTemplateRequest$Permissions' => '

A list of resource permissions to be set on the template.

', 'CreateThemeRequest$Permissions' => '

A valid grouping of resource permissions to apply to the new theme.

', 'DescribeAnalysisPermissionsResponse$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis.

', 'DescribeDashboardPermissionsResponse$Permissions' => '

A structure that contains the permissions for the dashboard.

', 'DescribeDataSetPermissionsResponse$Permissions' => '

A list of resource permissions on the dataset.

', 'DescribeDataSourcePermissionsResponse$Permissions' => '

A list of resource permissions on the data source.

', 'DescribeFolderPermissionsResponse$Permissions' => '

Information about the permissions on the folder.

', 'DescribeFolderResolvedPermissionsResponse$Permissions' => '

Information about the permissions for the folder.

', 'DescribeTemplatePermissionsResponse$Permissions' => '

A list of resource permissions to be set on the template.

', 'DescribeThemePermissionsResponse$Permissions' => '

A list of resource permissions set on the theme.

', 'DescribeTopicPermissionsResponse$Permissions' => '

A list of resource permissions that are configured to the topic.

', 'LinkSharingConfiguration$Permissions' => '

A structure that contains the permissions of a shareable link.

', 'UpdateAnalysisPermissionsResponse$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis.

', 'UpdateDashboardPermissionsResponse$Permissions' => '

Information about the permissions on the dashboard.

', 'UpdateDataSetPermissionsRequest$GrantPermissions' => '

The resource permissions that you want to grant to the dataset.

', 'UpdateDataSetPermissionsRequest$RevokePermissions' => '

The resource permissions that you want to revoke from the dataset.

', 'UpdateDataSourcePermissionsRequest$GrantPermissions' => '

A list of resource permissions that you want to grant on the data source.

', 'UpdateDataSourcePermissionsRequest$RevokePermissions' => '

A list of resource permissions that you want to revoke on the data source.

', 'UpdateFolderPermissionsRequest$GrantPermissions' => '

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

', 'UpdateFolderPermissionsRequest$RevokePermissions' => '

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

', 'UpdateFolderPermissionsResponse$Permissions' => '

Information about the permissions for the folder.

', 'UpdateTemplatePermissionsResponse$Permissions' => '

A list of resource permissions to be set on the template.

', 'UpdateThemePermissionsResponse$Permissions' => '

The resulting list of resource permissions for the theme.

', 'UpdateTopicPermissionsResponse$Permissions' => '

A list of resource permissions on the topic.

', ], ], 'ResourceStatus' => [ 'base' => NULL, 'refs' => [ 'Analysis$Status' => '

Status associated with the analysis.

', 'AnalysisSummary$Status' => '

The last known status for the analysis.

', 'CreateAnalysisResponse$CreationStatus' => '

The status of the creation of the analysis.

', 'CreateDashboardResponse$CreationStatus' => '

The status of the dashboard creation request.

', 'CreateDataSourceResponse$CreationStatus' => '

The status of creating the data source.

', 'CreateTemplateResponse$CreationStatus' => '

The template creation status.

', 'CreateThemeResponse$CreationStatus' => '

The theme creation status.

', 'DashboardVersion$Status' => '

The HTTP status of the request.

', 'DashboardVersionSummary$Status' => '

The HTTP status of the request.

', 'DataSource$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisDefinitionResponse$ResourceStatus' => '

Status associated with the analysis.

', 'DescribeDashboardDefinitionResponse$ResourceStatus' => '

Status associated with the dashboard version.

', 'DescribeTemplateDefinitionResponse$ResourceStatus' => '

Status associated with the template.

', 'TemplateVersion$Status' => '

The status that is associated with the template.

', 'TemplateVersionSummary$Status' => '

The status of the template version.

', 'ThemeVersion$Status' => '

The status of the theme version.

', 'ThemeVersionSummary$Status' => '

The status of the theme version.

', 'UpdateAnalysisResponse$UpdateStatus' => '

The update status of the last update that was made to the analysis.

', 'UpdateDashboardResponse$CreationStatus' => '

The creation status of the request.

', 'UpdateDataSourceResponse$UpdateStatus' => '

The update status of the data source\'s last update.

', 'UpdateTemplateResponse$CreationStatus' => '

The creation status of the template.

', 'UpdateThemeResponse$CreationStatus' => '

The creation status of the theme.

', ], ], 'ResourceUnavailableException' => [ 'base' => '

This resource is currently unavailable.

', 'refs' => [], ], 'RestoreAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'RestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserGenerativeQnAEmbeddingConfiguration$InitialTopicId' => '

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.

', 'AnonymousUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

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.

', 'CreateFolderMembershipRequest$FolderId' => '

The ID of the folder.

', 'CreateFolderMembershipRequest$MemberId' => '

The ID of the asset that you want to add to the folder.

', 'CreateFolderRequest$FolderId' => '

The ID of the folder.

', 'CreateFolderResponse$FolderId' => '

The folder ID for the newly created folder.

', 'DeleteFolderMembershipRequest$FolderId' => '

The Folder ID.

', 'DeleteFolderMembershipRequest$MemberId' => '

The ID of the asset that you want to delete.

', 'DeleteFolderRequest$FolderId' => '

The ID of the folder.

', 'DeleteFolderResponse$FolderId' => '

The ID of the folder.

', 'DescribeFolderPermissionsRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderPermissionsResponse$FolderId' => '

The ID of the folder.

', 'DescribeFolderRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderResolvedPermissionsRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderResolvedPermissionsResponse$FolderId' => '

The ID of the folder.

', 'Folder$FolderId' => '

The ID of the folder.

', 'FolderMember$MemberId' => '

The ID of an asset in the folder.

', 'FolderSummary$FolderId' => '

The ID of the folder.

', 'ListFolderMembersRequest$FolderId' => '

The ID of the folder.

', 'MemberIdArnPair$MemberId' => '

The ID of the member.

', 'RegisteredUserGenerativeQnAEmbeddingConfiguration$InitialTopicId' => '

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.

', 'RegisteredUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

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.

', 'UpdateFolderPermissionsRequest$FolderId' => '

The ID of the folder.

', 'UpdateFolderPermissionsResponse$FolderId' => '

The ID of the folder.

', 'UpdateFolderRequest$FolderId' => '

The ID of the folder.

', 'UpdateFolderResponse$FolderId' => '

The ID of the folder.

', ], ], 'ReviewedAnswerErrorCode' => [ 'base' => NULL, 'refs' => [ 'InvalidTopicReviewedAnswer$Error' => '

The error that is returned for the InvalidTopicReviewedAnswer.

', ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'CreateRoleMembershipRequest$Role' => '

The role that you want to add a group to.

', 'DeleteRoleCustomPermissionRequest$Role' => '

The role that you want to remove permissions from.

', 'DeleteRoleMembershipRequest$Role' => '

The role that you want to remove permissions from.

', 'DescribeRoleCustomPermissionRequest$Role' => '

The name of the role whose permissions you want described.

', 'ListRoleMembershipsRequest$Role' => '

The name of the role.

', 'UpdateRoleCustomPermissionRequest$Role' => '

The name of role tht you want to update.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$RoleArn' => '

An optional override of the role ARN to be used by the VPC connection.

', 'AthenaParameters$RoleArn' => '

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

', 'CreateVPCConnectionRequest$RoleArn' => '

The IAM role to associate with the VPC connection.

', 'RedshiftIAMParameters$RoleArn' => '

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.

', 'S3Parameters$RoleArn' => '

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

', 'UpdateVPCConnectionRequest$RoleArn' => '

An IAM role associated with the VPC connection.

', ], ], 'RoleName' => [ 'base' => NULL, 'refs' => [ 'DescribeRoleCustomPermissionResponse$CustomPermissionsName' => '

The name of the custom permission that is described.

', 'RegisterUserRequest$CustomPermissionsName' => '

(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:

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.

', 'UpdateRoleCustomPermissionRequest$CustomPermissionsName' => '

The name of the custom permission that you want to update the role with.

', 'UpdateUserRequest$CustomPermissionsName' => '

(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:

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.

', 'User$CustomPermissionsName' => '

The custom permissions profile associated with this user.

', ], ], 'RoleSessionName' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$SessionName' => '

You need to use this parameter only when you register one or more users using an assumed IAM role. You don\'t need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.

', ], ], 'RollingDateConfiguration' => [ 'base' => '

The rolling date configuration of a date time filter.

', 'refs' => [ 'DateTimeDefaultValues$RollingDate' => '

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

', 'TimeEqualityFilter$RollingDate' => '

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName.

', 'TimeRangeFilterValue$RollingDate' => '

The rolling date input value.

', ], ], 'RowAlternateColorList' => [ 'base' => NULL, 'refs' => [ 'RowAlternateColorOptions$RowAlternateColors' => '

Determines the list of row alternate colors.

', ], ], 'RowAlternateColorOptions' => [ 'base' => '

Determines the row alternate color options.

', 'refs' => [ 'PivotTableOptions$RowAlternateColorOptions' => '

The row alternate color options (widget status, row alternate colors).

', 'TableOptions$RowAlternateColorOptions' => '

The row alternate color options (widget status, row alternate colors) for a table.

', ], ], 'RowInfo' => [ 'base' => '

Information about rows for a data set SPICE ingestion.

', 'refs' => [ 'Ingestion$RowInfo' => NULL, ], ], 'RowLevelPermissionDataSet' => [ 'base' => '

Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

', 'refs' => [ 'CreateDataSetRequest$RowLevelPermissionDataSet' => '

The row-level security configuration for the data that you want to create.

', 'DataSet$RowLevelPermissionDataSet' => '

The row-level security configuration for the dataset.

', 'DataSetSummary$RowLevelPermissionDataSet' => '

The row-level security configuration for the dataset.

', 'UpdateDataSetRequest$RowLevelPermissionDataSet' => '

The row-level security configuration for the data you want to create.

', ], ], 'RowLevelPermissionFormatVersion' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$FormatVersion' => '

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

', ], ], 'RowLevelPermissionPolicy' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$PermissionPolicy' => '

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

', ], ], 'RowLevelPermissionTagConfiguration' => [ 'base' => '

The configuration of tags on a dataset to set row-level security.

', 'refs' => [ 'CreateDataSetRequest$RowLevelPermissionTagConfiguration' => '

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

', 'DataSet$RowLevelPermissionTagConfiguration' => '

The element you can use to define tags for row-level security.

', 'UpdateDataSetRequest$RowLevelPermissionTagConfiguration' => '

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

', ], ], 'RowLevelPermissionTagDelimiter' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$TagMultiValueDelimiter' => '

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

', ], ], 'RowLevelPermissionTagRule' => [ 'base' => '

A set of rules associated with a tag.

', 'refs' => [ 'RowLevelPermissionTagRuleList$member' => NULL, ], ], 'RowLevelPermissionTagRuleConfiguration' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRuleConfigurationList$member' => NULL, ], ], 'RowLevelPermissionTagRuleConfigurationList' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagConfiguration$TagRuleConfigurations' => '

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

', ], ], 'RowLevelPermissionTagRuleList' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagConfiguration$TagRules' => '

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

', ], ], 'RowSortList' => [ 'base' => NULL, 'refs' => [ 'TableSortConfiguration$RowSort' => '

The field sort options for rows in the table.

', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'ManifestFileLocation$Bucket' => '

Amazon S3 bucket.

', ], ], 'S3BucketConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'SnapshotS3DestinationConfiguration$BucketConfiguration' => '

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'ManifestFileLocation$Key' => '

Amazon S3 key that identifies an object.

', ], ], 'S3Parameters' => [ 'base' => '

The parameters for S3.

', 'refs' => [ 'DataSourceParameters$S3Parameters' => '

The parameters for S3.

', ], ], 'S3Source' => [ 'base' => '

A physical table type for an S3 data source.

', 'refs' => [ 'PhysicalTable$S3Source' => '

A physical table type for as S3 data source.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSource$S3Uri' => '

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can\'t exceed 20 MB.

', 'AssetBundleImportSourceDescription$S3Uri' => '

The Amazon S3 URI that you provided at the start of the import job.

', ], ], 'SameSheetTargetVisualConfiguration' => [ 'base' => '

The configuration of the same-sheet target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterOperationTargetVisualsConfiguration$SameSheetTargetVisualConfiguration' => '

The configuration of the same-sheet target visuals that you want to be filtered.

', ], ], 'SankeyDiagramAggregatedFieldWells' => [ 'base' => '

The field well configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramFieldWells$SankeyDiagramAggregatedFieldWells' => '

The field well configuration of a sankey diagram.

', ], ], 'SankeyDiagramChartConfiguration' => [ 'base' => '

The configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramVisual$ChartConfiguration' => '

The configuration of a sankey diagram.

', ], ], 'SankeyDiagramFieldWells' => [ 'base' => '

The field well configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramChartConfiguration$FieldWells' => '

The field well configuration of a sankey diagram.

', ], ], 'SankeyDiagramSortConfiguration' => [ 'base' => '

The sort configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramChartConfiguration$SortConfiguration' => '

The sort configuration of a sankey diagram.

', ], ], 'SankeyDiagramVisual' => [ 'base' => '

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$SankeyDiagramVisual' => '

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

', ], ], 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'base' => '

The aggregated field well of a scatter plot.

', 'refs' => [ 'ScatterPlotFieldWells$ScatterPlotCategoricallyAggregatedFieldWells' => '

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

', ], ], 'ScatterPlotConfiguration' => [ 'base' => '

The configuration of a scatter plot.

', 'refs' => [ 'ScatterPlotVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'ScatterPlotFieldWells' => [ 'base' => '

The field well configuration of a scatter plot.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ScatterPlotConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'ScatterPlotSortConfiguration' => [ 'base' => '

The sort configuration of a scatter plot.

', 'refs' => [ 'ScatterPlotConfiguration$SortConfiguration' => '

The sort configuration of a scatter plot.

', ], ], 'ScatterPlotUnaggregatedFieldWells' => [ 'base' => '

The unaggregated field wells of a scatter plot.

', 'refs' => [ 'ScatterPlotFieldWells$ScatterPlotUnaggregatedFieldWells' => '

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated.

', ], ], 'ScatterPlotVisual' => [ 'base' => '

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$ScatterPlotVisual' => '

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

', ], ], 'ScheduleRefreshOnEntity' => [ 'base' => '

The refresh on entity for weekly or monthly schedules.

', 'refs' => [ 'RefreshFrequency$RefreshOnDay' => '

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

', ], ], 'ScrollBarOptions' => [ 'base' => '

The visual display options for a data zoom scroll bar.

', 'refs' => [ 'AxisDisplayOptions$ScrollbarOptions' => '

The scroll bar options for an axis.

', ], ], 'SearchAnalysesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAnalysesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDashboardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDashboardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchFoldersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFoldersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Seasonality' => [ 'base' => NULL, 'refs' => [ 'TimeBasedForecastProperties$Seasonality' => '

The seasonality setup of a forecast computation. Choose one of the following options:

', ], ], 'SecondaryValueOptions' => [ 'base' => '

The options that determine the presentation of the secondary value of a KPI visual.

', 'refs' => [ 'KPIOptions$SecondaryValue' => '

The options that determine the presentation of the secondary value of a KPI visual.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentials$SecretArn' => '

The ARN of the Secrets Manager secret that\'s used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

', 'DataSource$SecretArn' => '

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

', 'DataSourceCredentials$SecretArn' => '

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

', ], ], 'SectionAfterPageBreak' => [ 'base' => '

The configuration of a page break after a section.

', 'refs' => [ 'BodySectionRepeatPageBreakConfiguration$After' => NULL, 'SectionPageBreakConfiguration$After' => '

The configuration of a page break after a section.

', ], ], 'SectionBasedLayoutCanvasSizeOptions' => [ 'base' => '

The options for the canvas of a section-based layout.

', 'refs' => [ 'DefaultSectionBasedLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a section-based layout.

', 'SectionBasedLayoutConfiguration$CanvasSizeOptions' => '

The options for the canvas of a section-based layout.

', ], ], 'SectionBasedLayoutConfiguration' => [ 'base' => '

The configuration for a section-based layout.

', 'refs' => [ 'LayoutConfiguration$SectionBasedLayout' => '

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

', ], ], 'SectionBasedLayoutPaperCanvasSizeOptions' => [ 'base' => '

The options for a paper canvas of a section-based layout.

', 'refs' => [ 'SectionBasedLayoutCanvasSizeOptions$PaperCanvasSizeOptions' => '

The options for a paper canvas of a section-based layout.

', ], ], 'SectionLayoutConfiguration' => [ 'base' => '

The layout configuration of a section.

', 'refs' => [ 'BodySectionContent$Layout' => '

The layout configuration of a body section.

', 'HeaderFooterSectionConfiguration$Layout' => '

The layout configuration of the header or footer section.

', ], ], 'SectionPageBreakConfiguration' => [ 'base' => '

The configuration of a page break for a section.

', 'refs' => [ 'BodySectionConfiguration$PageBreakConfiguration' => '

The configuration of a page break for a section.

', ], ], 'SectionPageBreakStatus' => [ 'base' => NULL, 'refs' => [ 'SectionAfterPageBreak$Status' => '

The option that enables or disables a page break at the end of a section.

', ], ], 'SectionStyle' => [ 'base' => '

The options that style a section.

', 'refs' => [ 'BodySectionConfiguration$Style' => '

The style options of a body section.

', 'HeaderFooterSectionConfiguration$Style' => '

The style options of a header or footer section.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIdList$member' => NULL, ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$SecurityGroupIds' => '

A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.

', 'CreateVPCConnectionRequest$SecurityGroupIds' => '

A list of security group IDs for the VPC connection.

', 'UpdateVPCConnectionRequest$SecurityGroupIds' => '

A list of security group IDs for the VPC connection.

', 'VPCConnection$SecurityGroupIds' => '

The Amazon EC2 security group IDs associated with the VPC connection.

', 'VPCConnectionSummary$SecurityGroupIds' => '

The Amazon EC2 security group IDs associated with the VPC connection.

', ], ], 'SelectAllValueOptions' => [ 'base' => NULL, 'refs' => [ 'DestinationParameterValueConfiguration$SelectAllValueOptions' => '

The configuration that selects all options.

', ], ], 'SelectedFieldList' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedFields' => '

Chooses the fields that are filtered in CustomActionFilterOperation.

', ], ], 'SelectedFieldOptions' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedFieldOptions' => '

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

Valid values are defined as follows:

', ], ], 'SelectedSheetsFilterScopeConfiguration' => [ 'base' => '

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterScopeConfiguration$SelectedSheets' => '

The configuration for applying a filter to specific sheets.

', ], ], 'SelectedTooltipType' => [ 'base' => NULL, 'refs' => [ 'TooltipOptions$SelectedTooltipType' => '

The selected type for the tooltip. Choose one of the following options:

', ], ], 'SemanticEntityType' => [ 'base' => '

A structure that represents a semantic entity type.

', 'refs' => [ 'TopicNamedEntity$SemanticEntityType' => '

The type of named entity that a topic represents.

', ], ], 'SemanticType' => [ 'base' => '

A structure that represents a semantic type.

', 'refs' => [ 'TopicCalculatedField$SemanticType' => '

The semantic type.

', 'TopicColumn$SemanticType' => '

The semantic type of data contained in the column.

', ], ], 'SensitiveDouble' => [ 'base' => NULL, 'refs' => [ 'DecimalValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'ReferenceLineStaticDataConfiguration$Value' => '

The double input of the static data.

', 'SensitiveDoubleList$member' => NULL, ], ], 'SensitiveDoubleList' => [ 'base' => NULL, 'refs' => [ 'DecimalParameter$Values' => '

The values for the decimal parameter.

', ], ], 'SensitiveDoubleObject' => [ 'base' => NULL, 'refs' => [ 'DecimalDefaultValueList$member' => NULL, ], ], 'SensitiveLong' => [ 'base' => NULL, 'refs' => [ 'IntegerValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'SensitiveLongList$member' => NULL, ], ], 'SensitiveLongList' => [ 'base' => NULL, 'refs' => [ 'IntegerParameter$Values' => '

The values for the integer parameter.

', ], ], 'SensitiveLongObject' => [ 'base' => NULL, 'refs' => [ 'IntegerDefaultValueList$member' => NULL, ], ], 'SensitiveS3Uri' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSourceDescription$Body' => '

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

', 'DescribeAssetBundleExportJobResponse$DownloadUrl' => '

The URL to download the exported asset bundle data from.

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

This URL can\'t be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

', 'SnapshotJobS3Result$S3Uri' => '

The Amazon S3 Uri.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'DataFieldSeriesItem$FieldValue' => '

The field value of the field that you are setting the axis binding to.

', 'SemanticType$TruthyCellValue' => '

The semantic type truthy cell value.

', 'SemanticType$FalseyCellValue' => '

The semantic type falsey cell value.

', 'SensitiveStringList$member' => NULL, 'StringValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', ], ], 'SensitiveStringList' => [ 'base' => NULL, 'refs' => [ 'SemanticType$TruthyCellValueSynonyms' => '

The other names or aliases for the true cell value.

', 'SemanticType$FalseyCellValueSynonyms' => '

The other names or aliases for the false cell value.

', 'StringParameter$Values' => '

The values of a string parameter.

', ], ], 'SensitiveStringObject' => [ 'base' => NULL, 'refs' => [ 'StringDefaultValueList$member' => NULL, ], ], 'SensitiveTimestamp' => [ 'base' => NULL, 'refs' => [ 'DateTimeDefaultValueList$member' => NULL, 'DateTimeValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'SensitiveTimestampList$member' => NULL, ], ], 'SensitiveTimestampList' => [ 'base' => NULL, 'refs' => [ 'DateTimeParameter$Values' => '

The values for the date-time parameter.

', ], ], 'SeriesItem' => [ 'base' => '

The series item configuration of a line chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'SeriesItemList$member' => NULL, ], ], 'SeriesItemList' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$Series' => '

The series item configuration of a line chart.

', ], ], 'ServiceNowParameters' => [ 'base' => '

The parameters for ServiceNow.

', 'refs' => [ 'DataSourceParameters$ServiceNowParameters' => '

The parameters for ServiceNow.

', ], ], 'ServiceType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedTargetsByService$Service' => '

The name of the Amazon Web Services service.

', 'DeleteIdentityPropagationConfigRequest$Service' => '

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

', 'UpdateIdentityPropagationConfigRequest$Service' => '

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

', ], ], 'SessionLifetimeInMinutes' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

', 'GenerateEmbedUrlForRegisteredUserRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

', 'GetDashboardEmbedUrlRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

', 'GetSessionEmbedUrlRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

', ], ], 'SessionLifetimeInMinutesInvalidException' => [ 'base' => '

The number of minutes specified for the lifetime of a session isn\'t valid. The session lifetime must be 15-600 minutes.

', 'refs' => [], ], 'SessionTag' => [ 'base' => '

The key-value pair used for the row-level security tags feature.

', 'refs' => [ 'SessionTagList$member' => NULL, ], ], 'SessionTagKey' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$TagKey' => '

The unique key for a tag.

', 'RowLevelPermissionTagRuleConfiguration$member' => NULL, 'SessionTag$Key' => '

The key for the tag.

', 'SessionTagKeyList$member' => NULL, ], ], 'SessionTagKeyList' => [ 'base' => NULL, 'refs' => [ 'SnapshotAnonymousUserRedacted$RowLevelPermissionTagKeys' => '

The tag keys for the RowLevelPermissionTags.

', ], ], 'SessionTagList' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$SessionTags' => '

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

', 'SnapshotAnonymousUser$RowLevelPermissionTags' => '

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.

', ], ], 'SessionTagValue' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$MatchAllValue' => '

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

', 'SessionTag$Value' => '

The value that you want to assign the tag.

', ], ], 'SetParameterValueConfiguration' => [ 'base' => '

The configuration of adding parameters in action.

', 'refs' => [ 'SetParameterValueConfigurationList$member' => NULL, ], ], 'SetParameterValueConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CustomActionSetParametersOperation$ParameterValueConfigurations' => '

The parameter that determines the value configuration.

', ], ], 'ShapeConditionalFormat' => [ 'base' => '

The shape conditional formatting of a filled map visual.

', 'refs' => [ 'FilledMapShapeConditionalFormatting$Format' => '

The conditional formatting that determines the background color of a filled map\'s shape.

', ], ], 'SharedViewConfigurations' => [ 'base' => '

The shared view settings of an embedded dashboard.

', 'refs' => [ 'AnonymousUserDashboardFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', 'RegisteredUserConsoleFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', 'RegisteredUserDashboardFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', ], ], 'SharingModel' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$SharingModel' => '

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

', 'Folder$SharingModel' => '

The sharing scope of the folder.

', 'FolderSummary$SharingModel' => '

The sharing scope of the folder.

', ], ], 'Sheet' => [ 'base' => '

A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

', 'refs' => [ 'SheetList$member' => NULL, ], ], 'SheetContentType' => [ 'base' => NULL, 'refs' => [ 'DefaultNewSheetConfiguration$SheetContentType' => '

The option that determines the sheet content type.

', 'SheetDefinition$ContentType' => '

The layout content type of the sheet. Choose one of the following options:

', ], ], 'SheetControlDateTimePickerType' => [ 'base' => NULL, 'refs' => [ 'DefaultDateTimePickerControlOptions$Type' => '

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

', 'FilterDateTimePickerControl$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', ], ], 'SheetControlInfoIconLabelOptions' => [ 'base' => '

A control to display info icons for filters and parameters.

', 'refs' => [ 'DateTimePickerControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'DropDownControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'ListControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'RelativeDateTimeControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'SliderControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'TextAreaControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'TextFieldControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', ], ], 'SheetControlInfoIconText' => [ 'base' => NULL, 'refs' => [ 'SheetControlInfoIconLabelOptions$InfoIconText' => '

The text content of info icon.

', ], ], 'SheetControlLayout' => [ 'base' => '

A grid layout to define the placement of sheet control.

', 'refs' => [ 'SheetControlLayoutList$member' => NULL, ], ], 'SheetControlLayoutConfiguration' => [ 'base' => '

The configuration that determines the elements and canvas size options of sheet control.

', 'refs' => [ 'SheetControlLayout$Configuration' => '

The configuration that determines the elements and canvas size options of sheet control.

', ], ], 'SheetControlLayoutList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$SheetControlLayouts' => '

The control layouts of the sheet.

', ], ], 'SheetControlListType' => [ 'base' => NULL, 'refs' => [ 'DefaultFilterDropDownControlOptions$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', 'DefaultFilterListControlOptions$Type' => '

The type of the DefaultFilterListControlOptions. Choose one of the following options:

', 'FilterDropDownControl$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', 'FilterListControl$Type' => '

The type of the FilterListControl. Choose one of the following options:

', 'ParameterDropDownControl$Type' => '

The type parameter name of the ParameterDropDownControl.

', 'ParameterListControl$Type' => '

The type of ParameterListControl.

', ], ], 'SheetControlSliderType' => [ 'base' => NULL, 'refs' => [ 'DefaultSliderControlOptions$Type' => '

The type of the DefaultSliderControlOptions. Choose one of the following options:

', 'FilterSliderControl$Type' => '

The type of the FilterSliderControl. Choose one of the following options:

', ], ], 'SheetControlTitle' => [ 'base' => NULL, 'refs' => [ 'DefaultFilterControlConfiguration$Title' => '

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

', 'FilterDateTimePickerControl$Title' => '

The title of the FilterDateTimePickerControl.

', 'FilterDropDownControl$Title' => '

The title of the FilterDropDownControl.

', 'FilterListControl$Title' => '

The title of the FilterListControl.

', 'FilterRelativeDateTimeControl$Title' => '

The title of the FilterTextAreaControl.

', 'FilterSliderControl$Title' => '

The title of the FilterSliderControl.

', 'FilterTextAreaControl$Title' => '

The title of the FilterTextAreaControl.

', 'FilterTextFieldControl$Title' => '

The title of the FilterTextFieldControl.

', 'ParameterDateTimePickerControl$Title' => '

The title of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$Title' => '

The title of the ParameterDropDownControl.

', 'ParameterListControl$Title' => '

The title of the ParameterListControl.

', 'ParameterSliderControl$Title' => '

The title of the ParameterSliderControl.

', 'ParameterTextAreaControl$Title' => '

The title of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$Title' => '

The title of the ParameterTextFieldControl.

', ], ], 'SheetControlsOption' => [ 'base' => '

Sheet controls option.

', 'refs' => [ 'DashboardPublishOptions$SheetControlsOption' => '

Sheet controls option.

', ], ], 'SheetDefinition' => [ 'base' => '

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

', 'refs' => [ 'SheetDefinitionList$member' => NULL, ], ], 'SheetDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$Sheets' => '

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

', 'DashboardVersionDefinition$Sheets' => '

An array of sheet definitions for a dashboard.

', 'TemplateVersionDefinition$Sheets' => '

An array of sheet definitions for a template.

', ], ], 'SheetDescription' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Description' => '

A description of the sheet.

', ], ], 'SheetElementConfigurationOverrides' => [ 'base' => '

The override configuration of the rendering rules of a sheet.

', 'refs' => [ 'SheetElementRenderingRule$ConfigurationOverrides' => '

The override configuration of the rendering rules of a sheet.

', ], ], 'SheetElementRenderingRule' => [ 'base' => '

The rendering rules of a sheet that uses a free-form layout.

', 'refs' => [ 'SheetElementRenderingRuleList$member' => NULL, ], ], 'SheetElementRenderingRuleList' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElement$RenderingRules' => '

The rendering rules that determine when an element should be displayed within a free-form layout.

', ], ], 'SheetLayoutElementMaximizationOption' => [ 'base' => '

The sheet layout maximization options of a dashbaord.

', 'refs' => [ 'DashboardPublishOptions$SheetLayoutElementMaximizationOption' => '

The sheet layout maximization options of a dashbaord.

', ], ], 'SheetList' => [ 'base' => NULL, 'refs' => [ 'Analysis$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', 'DashboardVersion$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', 'TemplateVersion$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', ], ], 'SheetName' => [ 'base' => NULL, 'refs' => [ 'Sheet$Name' => '

The name of a sheet. This name is displayed on the sheet\'s tab in the Amazon QuickSight console.

', 'SheetDefinition$Name' => '

The name of the sheet. This name is displayed on the sheet\'s tab in the Amazon QuickSight console.

', ], ], 'SheetStyle' => [ 'base' => '

The theme display options for sheets.

', 'refs' => [ 'ThemeConfiguration$Sheet' => '

Display options related to sheets.

', ], ], 'SheetTextBox' => [ 'base' => '

A text box.

', 'refs' => [ 'SheetTextBoxList$member' => NULL, ], ], 'SheetTextBoxContent' => [ 'base' => NULL, 'refs' => [ 'SheetTextBox$Content' => '

The content that is displayed in the text box.

', ], ], 'SheetTextBoxList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$TextBoxes' => '

The text boxes that are on a sheet.

', ], ], 'SheetTitle' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Title' => '

The title of the sheet.

', ], ], 'SheetVisualScopingConfiguration' => [ 'base' => '

The filter that is applied to the options.

', 'refs' => [ 'SheetVisualScopingConfigurations$member' => NULL, ], ], 'SheetVisualScopingConfigurations' => [ 'base' => NULL, 'refs' => [ 'SelectedSheetsFilterScopeConfiguration$SheetVisualScopingConfigurations' => '

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

', ], ], 'ShortFormatText' => [ 'base' => '

The text format for the title.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualTitleLabelOptions$FormatText' => '

The short text format of the title label, such as plain text or rich text.

', ], ], 'ShortPlainText' => [ 'base' => NULL, 'refs' => [ 'ShortFormatText$PlainText' => '

Plain text format.

', ], ], 'ShortRestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AdditionalDashboardIdList$member' => NULL, 'Analysis$AnalysisId' => '

The ID of the analysis.

', 'AnalysisSummary$AnalysisId' => '

The ID of the analysis. This ID displays in the URL.

', 'AnonymousUserDashboardEmbeddingConfiguration$InitialDashboardId' => '

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.

', 'AssetBundleExportJobSummary$AssetBundleExportJobId' => '

The ID of the export job.

', 'AssetBundleImportJobSummary$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'BarChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'BodySectionConfiguration$SectionId' => '

The unique identifier of a body section.

', 'BoxPlotVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'CategoryFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'ComboChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'CreateAnalysisRequest$AnalysisId' => '

The ID for the analysis that you\'re creating. This ID displays in the URL of the analysis.

', 'CreateAnalysisResponse$AnalysisId' => '

The ID of the analysis.

', 'CreateDashboardRequest$DashboardId' => '

The ID for the dashboard, also added to the IAM policy.

', 'CreateDashboardResponse$DashboardId' => '

The ID for the dashboard.

', 'CreateTemplateAliasRequest$TemplateId' => '

An ID for the template.

', 'CreateTemplateRequest$TemplateId' => '

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

', 'CreateTemplateResponse$TemplateId' => '

The ID of the template.

', 'CreateThemeAliasRequest$ThemeId' => '

An ID for the theme alias.

', 'CreateThemeRequest$ThemeId' => '

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

', 'CreateThemeRequest$BaseThemeId' => '

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

', 'CreateThemeResponse$ThemeId' => '

The ID of the theme.

', 'CustomContentVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'Dashboard$DashboardId' => '

Dashboard ID.

', 'DashboardSummary$DashboardId' => '

Dashboard ID.

', 'DashboardVisualId$DashboardId' => '

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.

', 'DashboardVisualId$SheetId' => '

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.

', 'DashboardVisualId$VisualId' => '

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.

', 'DeleteAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re deleting.

', 'DeleteAnalysisResponse$AnalysisId' => '

The ID of the deleted analysis.

', 'DeleteDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'DeleteDashboardResponse$DashboardId' => '

The ID of the dashboard.

', 'DeleteTemplateAliasRequest$TemplateId' => '

The ID for the template that the specified alias is for.

', 'DeleteTemplateAliasResponse$TemplateId' => '

An ID for the template associated with the deletion.

', 'DeleteTemplateRequest$TemplateId' => '

An ID for the template you want to delete.

', 'DeleteTemplateResponse$TemplateId' => '

An ID for the template.

', 'DeleteThemeAliasRequest$ThemeId' => '

The ID for the theme that the specified alias is for.

', 'DeleteThemeAliasResponse$ThemeId' => '

An ID for the theme associated with the deletion.

', 'DeleteThemeRequest$ThemeId' => '

An ID for the theme that you want to delete.

', 'DeleteThemeResponse$ThemeId' => '

An ID for the theme.

', 'DescribeAnalysisDefinitionRequest$AnalysisId' => '

The ID of the analysis that you\'re describing. The ID is part of the URL of the analysis.

', 'DescribeAnalysisDefinitionResponse$AnalysisId' => '

The ID of the analysis described.

', 'DescribeAnalysisPermissionsRequest$AnalysisId' => '

The ID of the analysis whose permissions you\'re describing. The ID is part of the analysis URL.

', 'DescribeAnalysisPermissionsResponse$AnalysisId' => '

The ID of the analysis whose permissions you\'re describing.

', 'DescribeAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re describing. The ID is part of the URL of the analysis.

', 'DescribeAssetBundleExportJobRequest$AssetBundleExportJobId' => '

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

', 'DescribeAssetBundleExportJobResponse$AssetBundleExportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

', 'DescribeAssetBundleImportJobRequest$AssetBundleImportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

', 'DescribeAssetBundleImportJobResponse$AssetBundleImportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

', 'DescribeDashboardDefinitionRequest$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardDefinitionResponse$DashboardId' => '

The ID of the dashboard described.

', 'DescribeDashboardPermissionsRequest$DashboardId' => '

The ID for the dashboard, also added to the IAM policy.

', 'DescribeDashboardPermissionsResponse$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardSnapshotJobRequest$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobRequest$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResponse$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobResponse$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResultRequest$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobResultRequest$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeTemplateAliasRequest$TemplateId' => '

The ID for the template.

', 'DescribeTemplateDefinitionRequest$TemplateId' => '

The ID of the template that you\'re describing.

', 'DescribeTemplateDefinitionResponse$TemplateId' => '

The ID of the template described.

', 'DescribeTemplatePermissionsRequest$TemplateId' => '

The ID for the template.

', 'DescribeTemplatePermissionsResponse$TemplateId' => '

The ID for the template.

', 'DescribeTemplateRequest$TemplateId' => '

The ID for the template.

', 'DescribeThemeAliasRequest$ThemeId' => '

The ID for the theme.

', 'DescribeThemePermissionsRequest$ThemeId' => '

The ID for the theme that you want to describe permissions for.

', 'DescribeThemePermissionsResponse$ThemeId' => '

The ID for the theme.

', 'DescribeThemeRequest$ThemeId' => '

The ID for the theme.

', 'EmptyVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'FilledMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'FilterCrossSheetControl$FilterControlId' => '

The ID of the FilterCrossSheetControl.

', 'FilterCrossSheetControl$SourceFilterId' => '

The source filter ID of the FilterCrossSheetControl.

', 'FilterDateTimePickerControl$FilterControlId' => '

The ID of the FilterDateTimePickerControl.

', 'FilterDateTimePickerControl$SourceFilterId' => '

The source filter ID of the FilterDateTimePickerControl.

', 'FilterDropDownControl$FilterControlId' => '

The ID of the FilterDropDownControl.

', 'FilterDropDownControl$SourceFilterId' => '

The source filter ID of the FilterDropDownControl.

', 'FilterGroup$FilterGroupId' => '

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

', 'FilterListControl$FilterControlId' => '

The ID of the FilterListControl.

', 'FilterListControl$SourceFilterId' => '

The source filter ID of the FilterListControl.

', 'FilterRelativeDateTimeControl$FilterControlId' => '

The ID of the FilterTextAreaControl.

', 'FilterRelativeDateTimeControl$SourceFilterId' => '

The source filter ID of the FilterTextAreaControl.

', 'FilterSliderControl$FilterControlId' => '

The ID of the FilterSliderControl.

', 'FilterSliderControl$SourceFilterId' => '

The source filter ID of the FilterSliderControl.

', 'FilterTextAreaControl$FilterControlId' => '

The ID of the FilterTextAreaControl.

', 'FilterTextAreaControl$SourceFilterId' => '

The source filter ID of the FilterTextAreaControl.

', 'FilterTextFieldControl$FilterControlId' => '

The ID of the FilterTextFieldControl.

', 'FilterTextFieldControl$SourceFilterId' => '

The source filter ID of the FilterTextFieldControl.

', 'FilteredVisualsList$member' => NULL, 'ForecastComputation$ComputationId' => '

The ID for a computation.

', 'FreeFormLayoutElement$ElementId' => '

A unique identifier for an element within a free-form layout.

', 'FunnelChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'GaugeChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'GeospatialMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'GetDashboardEmbedUrlRequest$DashboardId' => '

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

', 'GridLayoutElement$ElementId' => '

A unique identifier for an element within a grid layout.

', 'GrowthRateComputation$ComputationId' => '

The ID for a computation.

', 'HeaderFooterSectionConfiguration$SectionId' => '

The unique identifier of the header or footer section.

', 'HeatMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'HistogramVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'InsightVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'KPIVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'LineChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'ListDashboardVersionsRequest$DashboardId' => '

The ID for the dashboard.

', 'ListTemplateAliasesRequest$TemplateId' => '

The ID for the template.

', 'ListTemplateVersionsRequest$TemplateId' => '

The ID for the template.

', 'ListThemeAliasesRequest$ThemeId' => '

The ID for the theme.

', 'ListThemeVersionsRequest$ThemeId' => '

The ID for the theme.

', 'LocalNavigationConfiguration$TargetSheetId' => '

The sheet that is targeted for navigation in the same analysis.

', 'MaximumMinimumComputation$ComputationId' => '

The ID for a computation.

', 'MetricComparisonComputation$ComputationId' => '

The ID for a computation.

', 'NestedFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'NonRepeatingVisualsList$member' => NULL, 'NumericEqualityFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'NumericRangeFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'ParameterDateTimePickerControl$ParameterControlId' => '

The ID of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$ParameterControlId' => '

The ID of the ParameterDropDownControl.

', 'ParameterListControl$ParameterControlId' => '

The ID of the ParameterListControl.

', 'ParameterSliderControl$ParameterControlId' => '

The ID of the ParameterSliderControl.

', 'ParameterTextAreaControl$ParameterControlId' => '

The ID of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$ParameterControlId' => '

The ID of the ParameterTextFieldControl.

', 'PeriodOverPeriodComputation$ComputationId' => '

The ID for a computation.

', 'PeriodToDateComputation$ComputationId' => '

The ID for a computation.

', 'PieChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'PivotTableVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'RadarChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'RegisteredUserDashboardEmbeddingConfiguration$InitialDashboardId' => '

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.

', 'RelativeDatesFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'RestoreAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re restoring.

', 'RestoreAnalysisResponse$AnalysisId' => '

The ID of the analysis that you\'re restoring.

', 'SankeyDiagramVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'ScatterPlotVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'Sheet$SheetId' => '

The unique identifier associated with a sheet.

', 'SheetDefinition$SheetId' => '

The unique identifier of a sheet.

', 'SheetTextBox$SheetTextBoxId' => '

The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

', 'SheetVisualScopingConfiguration$SheetId' => '

The selected sheet that the filter is applied to.

', 'SnapshotFileSheetSelection$SheetId' => '

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

', 'SnapshotFileSheetSelectionVisualIdList$member' => NULL, 'StartAssetBundleExportJobRequest$AssetBundleExportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleExportJobResponse$AssetBundleExportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleImportJobRequest$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleImportJobResponse$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartDashboardSnapshotJobRequest$DashboardId' => '

The ID of the dashboard that you want to start a snapshot job for.

', 'StartDashboardSnapshotJobRequest$SnapshotJobId' => '

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

', 'StartDashboardSnapshotJobResponse$SnapshotJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'TableVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'TargetVisualList$member' => NULL, 'Template$TemplateId' => '

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'TemplateSummary$TemplateId' => '

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'Theme$ThemeId' => '

The identifier that the user gives to the theme.

', 'ThemeSummary$ThemeId' => '

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ThemeVersion$BaseThemeId' => '

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

', 'TimeEqualityFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TimeRangeFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TopBottomFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TopBottomMoversComputation$ComputationId' => '

The ID for a computation.

', 'TopBottomRankedComputation$ComputationId' => '

The ID for a computation.

', 'TotalAggregationComputation$ComputationId' => '

The ID for a computation.

', 'TreeMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'UniqueValuesComputation$ComputationId' => '

The ID for a computation.

', 'UpdateAnalysisPermissionsRequest$AnalysisId' => '

The ID of the analysis whose permissions you\'re updating. The ID is part of the analysis URL.

', 'UpdateAnalysisPermissionsResponse$AnalysisId' => '

The ID of the analysis that you updated permissions for.

', 'UpdateAnalysisRequest$AnalysisId' => '

The ID for the analysis that you\'re updating. This ID displays in the URL of the analysis.

', 'UpdateAnalysisResponse$AnalysisId' => '

The ID of the analysis.

', 'UpdateDashboardLinksRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPermissionsRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPermissionsResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPublishedVersionRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPublishedVersionResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateTemplateAliasRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplatePermissionsRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplatePermissionsResponse$TemplateId' => '

The ID for the template.

', 'UpdateTemplateRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplateResponse$TemplateId' => '

The ID for the template.

', 'UpdateThemeAliasRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemePermissionsRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemePermissionsResponse$ThemeId' => '

The ID for the theme.

', 'UpdateThemeRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemeRequest$BaseThemeId' => '

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

', 'UpdateThemeResponse$ThemeId' => '

The ID for the theme.

', 'VisualCustomAction$CustomActionId' => '

The ID of the VisualCustomAction.

', 'WaterfallVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'WordCloudVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', ], ], 'ShortRichText' => [ 'base' => NULL, 'refs' => [ 'ShortFormatText$RichText' => '

Rich text. Examples of rich text include bold, underline, and italics.

', ], ], 'SignupResponse' => [ 'base' => '

A SignupResponse object that contains a summary of a newly created account.

', 'refs' => [ 'CreateAccountSubscriptionResponse$SignupResponse' => '

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

', ], ], 'SimpleAttributeAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AttributeAggregationFunction$SimpleAttributeAggregation' => '

The built-in aggregation functions for attributes.

', ], ], 'SimpleClusterMarker' => [ 'base' => '

The simple cluster marker of the cluster marker.

', 'refs' => [ 'ClusterMarker$SimpleClusterMarker' => '

The simple cluster marker of the cluster marker.

', ], ], 'SimpleNumericalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'NumericalAggregationFunction$SimpleNumericalAggregation' => '

Built-in aggregation functions for numerical values.

', ], ], 'SimpleTotalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'TotalAggregationFunction$SimpleTotalAggregationFunction' => '

A built in aggregation function for total values.

', ], ], 'SingleAxisOptions' => [ 'base' => '

The settings of a chart\'s single axis configuration.

', 'refs' => [ 'ComboChartConfiguration$SingleAxisOptions' => NULL, 'LineChartConfiguration$SingleAxisOptions' => NULL, ], ], 'SingleYAxisOption' => [ 'base' => NULL, 'refs' => [ 'YAxisOptions$YAxis' => '

The Y axis type to be used in the chart.

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

', ], ], 'SiteBaseUrl' => [ 'base' => NULL, 'refs' => [ 'JiraParameters$SiteBaseUrl' => '

The base URL of the Jira site.

', 'ServiceNowParameters$SiteBaseUrl' => '

URL of the base site.

', ], ], 'SliderControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultSliderControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterSliderControl$DisplayOptions' => '

The display options of a control.

', 'ParameterSliderControl$DisplayOptions' => '

The display options of a control.

', ], ], 'Slot' => [ 'base' => '

The definition for the slot.

', 'refs' => [ 'Slots$member' => NULL, ], ], 'Slots' => [ 'base' => NULL, 'refs' => [ 'TopicTemplate$Slots' => '

The slots for the TopicTemplate.

', ], ], 'SmallMultiplesAxisPlacement' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesAxisProperties$Placement' => '

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

', ], ], 'SmallMultiplesAxisProperties' => [ 'base' => '

Configures the properties of a chart\'s axes that are used by small multiples panels.

', 'refs' => [ 'SmallMultiplesOptions$XAxis' => '

The properties of a small multiples X axis.

', 'SmallMultiplesOptions$YAxis' => '

The properties of a small multiples Y axis.

', ], ], 'SmallMultiplesAxisScale' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesAxisProperties$Scale' => '

Determines whether scale of the axes are shared or independent. The default value is SHARED.

', ], ], 'SmallMultiplesDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a bar chart.

', 'LineChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a line chart.

', 'PieChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a pie chart.

', ], ], 'SmallMultiplesOptions' => [ 'base' => '

Options that determine the layout and display options of a chart\'s small multiples.

', 'refs' => [ 'BarChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', 'LineChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', 'PieChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', ], ], 'SnapshotAnonymousUser' => [ 'base' => '

A structure that contains information on the anonymous user configuration.

', 'refs' => [ 'SnapshotAnonymousUserList$member' => NULL, ], ], 'SnapshotAnonymousUserList' => [ 'base' => NULL, 'refs' => [ 'SnapshotUserConfiguration$AnonymousUsers' => '

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

', ], ], 'SnapshotAnonymousUserRedacted' => [ 'base' => '

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

', 'refs' => [ 'SnapshotAnonymousUserRedactedList$member' => NULL, ], ], 'SnapshotAnonymousUserRedactedList' => [ 'base' => NULL, 'refs' => [ 'SnapshotUserConfigurationRedacted$AnonymousUsers' => '

An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.

', ], ], 'SnapshotConfiguration' => [ 'base' => '

Describes the configuration of the dashboard snapshot.

', 'refs' => [ 'DescribeDashboardSnapshotJobResponse$SnapshotConfiguration' => '

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

', 'StartDashboardSnapshotJobRequest$SnapshotConfiguration' => '

A structure that describes the configuration of the dashboard snapshot.

', ], ], 'SnapshotDestinationConfiguration' => [ 'base' => '

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

', 'refs' => [ 'SnapshotConfiguration$DestinationConfiguration' => '

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

', ], ], 'SnapshotFile' => [ 'base' => '

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

', 'refs' => [ 'SnapshotFileList$member' => NULL, ], ], 'SnapshotFileFormatType' => [ 'base' => NULL, 'refs' => [ 'SnapshotFile$FormatType' => '

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

', ], ], 'SnapshotFileGroup' => [ 'base' => '

A structure that contains the information on the snapshot files.

', 'refs' => [ 'SnapshotFileGroupList$member' => NULL, ], ], 'SnapshotFileGroupList' => [ 'base' => NULL, 'refs' => [ 'SnapshotConfiguration$FileGroups' => '

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

', ], ], 'SnapshotFileList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileGroup$Files' => '

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

', 'SnapshotJobResultFileGroup$Files' => '

A list of SnapshotFile objects.

', ], ], 'SnapshotFileSheetSelection' => [ 'base' => '

A structure that contains information that identifies the snapshot that needs to be generated.

', 'refs' => [ 'SnapshotFileSheetSelectionList$member' => NULL, ], ], 'SnapshotFileSheetSelectionList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFile$SheetSelections' => '

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

', ], ], 'SnapshotFileSheetSelectionScope' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileSheetSelection$SelectionScope' => '

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

', ], ], 'SnapshotFileSheetSelectionVisualIdList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileSheetSelection$VisualIds' => '

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

', ], ], 'SnapshotJobErrorInfo' => [ 'base' => '

An object that contains information on the error that caused the snapshot job to fail.

', 'refs' => [ 'DescribeDashboardSnapshotJobResultResponse$ErrorInfo' => '

Displays information for the error that caused a job to fail.

', ], ], 'SnapshotJobResult' => [ 'base' => '

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

', 'refs' => [ 'DescribeDashboardSnapshotJobResultResponse$Result' => '

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

', ], ], 'SnapshotJobResultErrorInfo' => [ 'base' => '

Information on the error that caused the snapshot job to fail.

', 'refs' => [ 'SnapshotJobResultErrorInfoList$member' => NULL, ], ], 'SnapshotJobResultErrorInfoList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobS3Result$ErrorInfo' => '

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

', ], ], 'SnapshotJobResultFileGroup' => [ 'base' => '

A structure that contains information on the generated snapshot file groups.

', 'refs' => [ 'SnapshotJobResultFileGroupList$member' => NULL, ], ], 'SnapshotJobResultFileGroupList' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserSnapshotJobResult$FileGroups' => '

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

', ], ], 'SnapshotJobS3Result' => [ 'base' => '

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

', 'refs' => [ 'SnapshotJobS3ResultList$member' => NULL, ], ], 'SnapshotJobS3ResultList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobResultFileGroup$S3Results' => '

A list of SnapshotJobS3Result objects.

', ], ], 'SnapshotJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDashboardSnapshotJobResponse$JobStatus' => '

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

', 'DescribeDashboardSnapshotJobResultResponse$JobStatus' => '

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

', ], ], 'SnapshotS3DestinationConfiguration' => [ 'base' => '

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

', 'refs' => [ 'SnapshotJobS3Result$S3DestinationConfiguration' => '

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.

', 'SnapshotS3DestinationConfigurationList$member' => NULL, ], ], 'SnapshotS3DestinationConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SnapshotDestinationConfiguration$S3Destinations' => '

A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.

', ], ], 'SnapshotUserConfiguration' => [ 'base' => '

A structure that contains information about the users that the dashboard snapshot is generated for.

', 'refs' => [ 'StartDashboardSnapshotJobRequest$UserConfiguration' => '

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.

', ], ], 'SnapshotUserConfigurationRedacted' => [ 'base' => '

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.

', 'refs' => [ 'DescribeDashboardSnapshotJobResponse$UserConfiguration' => '

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

', ], ], 'SnowflakeParameters' => [ 'base' => '

The parameters for Snowflake.

', 'refs' => [ 'DataSourceParameters$SnowflakeParameters' => '

The parameters for Snowflake.

', ], ], 'SortDirection' => [ 'base' => NULL, 'refs' => [ 'AggregationSortConfiguration$SortDirection' => '

The sort direction of values.

', 'ColumnSort$Direction' => '

The sort direction.

', 'DataPathSort$Direction' => '

Determines the sort direction.

', 'FieldSort$Direction' => '

The sort direction. Choose one of the following options:

', ], ], 'Spacing' => [ 'base' => '

The configuration of spacing (often a margin or padding).

', 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperMargin' => '

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

', 'SectionStyle$Padding' => '

The spacing between section content and its top, bottom, left, and right edges.

There is no padding by default.

', ], ], 'SparkParameters' => [ 'base' => '

The parameters for Spark.

', 'refs' => [ 'DataSourceParameters$SparkParameters' => '

The parameters for Spark.

', ], ], 'SpecialValue' => [ 'base' => NULL, 'refs' => [ 'CustomColor$SpecialValue' => '

The value of a special data value.

', ], ], 'SqlEndpointPath' => [ 'base' => NULL, 'refs' => [ 'DatabricksParameters$SqlEndpointPath' => '

The HTTP path of the Databricks data source.

', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'CustomSql$SqlQuery' => '

The SQL query.

', ], ], 'SqlServerParameters' => [ 'base' => '

The parameters for SQL Server.

', 'refs' => [ 'DataSourceParameters$SqlServerParameters' => '

The parameters for SQL Server.

', ], ], 'SslProperties' => [ 'base' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$SslProperties' => NULL, 'CreateDataSourceRequest$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', 'DataSource$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', 'UpdateDataSourceRequest$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', ], ], 'StarburstParameters' => [ 'base' => '

The parameters that are required to connect to a Starburst data source.

', 'refs' => [ 'DataSourceParameters$StarburstParameters' => '

The parameters that are required to connect to a Starburst data source.

', ], ], 'StarburstProductType' => [ 'base' => NULL, 'refs' => [ 'StarburstParameters$ProductType' => '

The product type for the Starburst data source.

', ], ], 'StartAssetBundleExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDashboardSnapshotJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDashboardSnapshotJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatePersistenceConfigurations' => [ 'base' => '

The state perssitence configuration of an embedded dashboard.

', 'refs' => [ 'RegisteredUserConsoleFeatureConfigurations$StatePersistence' => '

The state persistence configurations of an embedded Amazon QuickSight console.

', 'RegisteredUserDashboardFeatureConfigurations$StatePersistence' => '

The state persistence settings of an embedded dashboard.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$Status' => '

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

', 'RowLevelPermissionTagConfiguration$Status' => '

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$Status' => '

The HTTP status of the request.

', 'BatchDeleteTopicReviewedAnswerResponse$Status' => '

The HTTP status of the request.

', 'CancelIngestionResponse$Status' => '

The HTTP status of the request.

', 'CreateAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'CreateAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'CreateAnalysisResponse$Status' => '

The HTTP status of the request.

', 'CreateDashboardResponse$Status' => '

The HTTP status of the request.

', 'CreateDataSetResponse$Status' => '

The HTTP status of the request.

', 'CreateDataSourceResponse$Status' => '

The HTTP status of the request.

', 'CreateFolderMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateFolderResponse$Status' => '

The HTTP status of the request.

', 'CreateGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateGroupResponse$Status' => '

The HTTP status of the request.

', 'CreateIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'CreateIngestionResponse$Status' => '

The HTTP status of the request.

', 'CreateNamespaceResponse$Status' => '

The HTTP status of the request.

', 'CreateRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'CreateRoleMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'CreateTemplateResponse$Status' => '

The HTTP status of the request.

', 'CreateThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'CreateThemeResponse$Status' => '

The HTTP status of the request.

', 'CreateTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'CreateTopicResponse$Status' => '

The HTTP status of the request.

', 'CreateVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'DeleteAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'DeleteAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'DeleteAnalysisResponse$Status' => '

The HTTP status of the request.

', 'DeleteDashboardResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSetResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSourceResponse$Status' => '

The HTTP status of the request.

', 'DeleteFolderMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteFolderResponse$Status' => '

The HTTP status of the request.

', 'DeleteGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteGroupResponse$Status' => '

The HTTP status of the request.

', 'DeleteIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'DeleteIdentityPropagationConfigResponse$Status' => '

The HTTP status of the request.

', 'DeleteNamespaceResponse$Status' => '

The HTTP status of the request.

', 'DeleteRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DeleteRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'DeleteRoleMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'DeleteTemplateResponse$Status' => '

The HTTP status of the request.

', 'DeleteThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'DeleteThemeResponse$Status' => '

The HTTP status of the request.

', 'DeleteTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DeleteTopicResponse$Status' => '

The HTTP status of the request.

', 'DeleteUserByPrincipalIdResponse$Status' => '

The HTTP status of the request.

', 'DeleteUserResponse$Status' => '

The HTTP status of the request.

', 'DeleteVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountSettingsResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisResponse$Status' => '

The HTTP status of the request.

', 'DescribeAssetBundleExportJobResponse$Status' => '

The HTTP status of the response.

', 'DescribeAssetBundleImportJobResponse$Status' => '

The HTTP status of the response.

', 'DescribeDashboardDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeDashboardPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDashboardResponse$Status' => '

The HTTP status of this request.

', 'DescribeDashboardSnapshotJobResponse$Status' => '

The HTTP status of the request

', 'DescribeDashboardSnapshotJobResultResponse$Status' => '

The HTTP status of the request

', 'DescribeDataSetPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSetResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSourcePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSourceResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderResolvedPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderResponse$Status' => '

The HTTP status of the request.

', 'DescribeGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'DescribeGroupResponse$Status' => '

The HTTP status of the request.

', 'DescribeIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'DescribeIngestionResponse$Status' => '

The HTTP status of the request.

', 'DescribeIpRestrictionResponse$Status' => '

The HTTP status of the request.

', 'DescribeKeyRegistrationResponse$Status' => '

The HTTP status of the request.

', 'DescribeNamespaceResponse$Status' => '

The HTTP status of the request.

', 'DescribeRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DescribeRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplatePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemeResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicRefreshResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicResponse$Status' => '

The HTTP status of the request.

', 'DescribeUserResponse$Status' => '

The HTTP status of the request.

', 'DescribeVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'FailedKeyRegistrationEntry$StatusCode' => '

The HTTP status of a FailedKeyRegistrationEntry error.

', 'GenerateEmbedUrlForAnonymousUserResponse$Status' => '

The HTTP status of the request.

', 'GenerateEmbedUrlForRegisteredUserResponse$Status' => '

The HTTP status of the request.

', 'GetDashboardEmbedUrlResponse$Status' => '

The HTTP status of the request.

', 'GetSessionEmbedUrlResponse$Status' => '

The HTTP status of the request.

', 'ListAnalysesResponse$Status' => '

The HTTP status of the request.

', 'ListAssetBundleExportJobsResponse$Status' => '

The HTTP status of the request.

', 'ListAssetBundleImportJobsResponse$Status' => '

The HTTP status of the response.

', 'ListDashboardVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListDashboardsResponse$Status' => '

The HTTP status of the request.

', 'ListDataSetsResponse$Status' => '

The HTTP status of the request.

', 'ListDataSourcesResponse$Status' => '

The HTTP status of the request.

', 'ListFolderMembersResponse$Status' => '

The HTTP status of the request.

', 'ListFoldersResponse$Status' => '

The HTTP status of the request.

', 'ListGroupMembershipsResponse$Status' => '

The HTTP status of the request.

', 'ListGroupsResponse$Status' => '

The HTTP status of the request.

', 'ListIAMPolicyAssignmentsForUserResponse$Status' => '

The HTTP status of the request.

', 'ListIAMPolicyAssignmentsResponse$Status' => '

The HTTP status of the request.

', 'ListIdentityPropagationConfigsResponse$Status' => '

The HTTP status of the request.

', 'ListIngestionsResponse$Status' => '

The HTTP status of the request.

', 'ListNamespacesResponse$Status' => '

The HTTP status of the request.

', 'ListRefreshSchedulesResponse$Status' => '

The HTTP status of the request.

', 'ListRoleMembershipsResponse$Status' => '

The HTTP status of the request.

', 'ListTagsForResourceResponse$Status' => '

The HTTP status of the request.

', 'ListTemplateAliasesResponse$Status' => '

The HTTP status of the request.

', 'ListTemplateVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListTemplatesResponse$Status' => '

The HTTP status of the request.

', 'ListThemeAliasesResponse$Status' => '

The HTTP status of the request.

', 'ListThemeVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListThemesResponse$Status' => '

The HTTP status of the request.

', 'ListTopicRefreshSchedulesResponse$Status' => '

The HTTP status of the request.

', 'ListTopicReviewedAnswersResponse$Status' => '

The HTTP status of the request.

', 'ListTopicsResponse$Status' => '

The HTTP status of the request.

', 'ListUserGroupsResponse$Status' => '

The HTTP status of the request.

', 'ListUsersResponse$Status' => '

The HTTP status of the request.

', 'ListVPCConnectionsResponse$Status' => '

The HTTP status of the request.

', 'PutDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'RegisterUserResponse$Status' => '

The HTTP status of the request.

', 'RestoreAnalysisResponse$Status' => '

The HTTP status of the request.

', 'SearchAnalysesResponse$Status' => '

The HTTP status of the request.

', 'SearchDashboardsResponse$Status' => '

The HTTP status of the request.

', 'SearchDataSetsResponse$Status' => '

The HTTP status of the request.

', 'SearchDataSourcesResponse$Status' => '

The HTTP status of the request.

', 'SearchFoldersResponse$Status' => '

The HTTP status of the request.

', 'SearchGroupsResponse$Status' => '

The HTTP status of the request.

', 'StartAssetBundleExportJobResponse$Status' => '

The HTTP status of the response.

', 'StartAssetBundleImportJobResponse$Status' => '

The HTTP status of the response.

', 'StartDashboardSnapshotJobResponse$Status' => '

The HTTP status of the request

', 'SuccessfulKeyRegistrationEntry$StatusCode' => '

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

', 'TagResourceResponse$Status' => '

The HTTP status of the request.

', 'UntagResourceResponse$Status' => '

The HTTP status of the request.

', 'UpdateAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'UpdateAccountSettingsResponse$Status' => '

The HTTP status of the request.

', 'UpdateAnalysisPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateAnalysisResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardLinksResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardPublishedVersionResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSetPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSetResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSourcePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSourceResponse$Status' => '

The HTTP status of the request.

', 'UpdateFolderPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateFolderResponse$Status' => '

The HTTP status of the request.

', 'UpdateGroupResponse$Status' => '

The HTTP status of the request.

', 'UpdateIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'UpdateIdentityPropagationConfigResponse$Status' => '

The HTTP status of the request.

', 'UpdateIpRestrictionResponse$Status' => '

The HTTP status of the request.

', 'UpdatePublicSharingSettingsResponse$Status' => '

The HTTP status of the request.

', 'UpdateRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'UpdateRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'UpdateSPICECapacityConfigurationResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplatePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplateResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemeResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicResponse$Status' => '

The HTTP status of the request.

', 'UpdateUserResponse$Status' => '

The HTTP status of the request.

', 'UpdateVPCConnectionResponse$Status' => '

The HTTP status of the request.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AccessDeniedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'AccountInfo$AccountName' => '

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.

', 'AccountInfo$NotificationEmail' => '

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

', 'AccountInfo$AuthenticationType' => '

The way that your Amazon QuickSight account is authenticated.

', 'AccountInfo$AccountSubscriptionStatus' => '

The status of your account subscription.

', 'AccountInfo$IAMIdentityCenterInstanceArn' => '

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

', 'AccountSettings$AccountName' => '

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.

', 'AccountSettings$NotificationEmail' => '

The main notification email for your Amazon QuickSight subscription.

', 'ActionList$member' => NULL, 'AnalysisSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$ScheduleId' => '

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

', 'AssetBundleImportJobResourceIdOverrideConfiguration$PrefixForAllResources' => '

An option to request a CloudFormation variable for a prefix to be prepended to each resource\'s ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

', 'AssetOptions$Timezone' => '

Determines the timezone for the analysis.

', 'AttributeAggregationFunction$ValueForMultipleValues' => '

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to \'*\'.

', 'AuthorizedTargetsList$member' => NULL, 'AxisLabelOptions$CustomLabel' => '

The text for the axis label.

', 'BatchCreateTopicReviewedAnswerResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'BatchDeleteTopicReviewedAnswerResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CancelIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'CancelIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CascadingControlSource$SourceSheetControlId' => '

The source sheet control ID of a CascadingControlSource.

', 'ColumnGroupColumnSchema$Name' => '

The name of the column group\'s column schema.

', 'ColumnGroupSchema$Name' => '

The name of the column group schema.

', 'ColumnNameList$member' => NULL, 'ColumnSchema$Name' => '

The name of the column schema.

', 'ColumnSchema$DataType' => '

The data type of the column schema.

', 'ColumnSchema$GeographicRole' => '

The geographic role of the column schema.

', 'ColumnTooltipItem$Label' => '

The label of the tooltip item.

', 'ConcurrentUpdatingException$Message' => NULL, 'ConcurrentUpdatingException$RequestId' => NULL, 'ConflictException$Message' => NULL, 'ConflictException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'CreateAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateAccountSubscriptionRequest$NotificationEmail' => '

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

', 'CreateAccountSubscriptionRequest$ActiveDirectoryName' => '

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

', 'CreateAccountSubscriptionRequest$Realm' => '

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.

', 'CreateAccountSubscriptionRequest$DirectoryId' => '

The ID of the Active Directory that is associated with your Amazon QuickSight account.

', 'CreateAccountSubscriptionRequest$FirstName' => '

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.

', 'CreateAccountSubscriptionRequest$LastName' => '

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.

', 'CreateAccountSubscriptionRequest$EmailAddress' => '

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.

', 'CreateAccountSubscriptionRequest$ContactNumber' => '

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.

', 'CreateAccountSubscriptionRequest$IAMIdentityCenterInstanceArn' => '

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

', 'CreateAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateFolderMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateFolderResponse$RequestId' => '

The request ID for the newly created folder.

', 'CreateGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateIAMPolicyAssignmentResponse$AssignmentId' => '

The ID for the assignment.

', 'CreateIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'CreateIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateNamespaceResponse$CapacityRegion' => '

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

', 'CreateNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'CreateRoleMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTopicRefreshScheduleRequest$DatasetName' => '

The name of the dataset.

', 'CreateTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CustomerManagedKeyUnavailableException$Message' => NULL, 'CustomerManagedKeyUnavailableException$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DashboardSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DataSetConfiguration$Placeholder' => '

Placeholder.

', 'DataSetSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DataSourceErrorInfo$Message' => '

Error message.

', 'DataSourceSearchFilter$Value' => '

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DeleteAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteFolderMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteIdentityPropagationConfigResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRefreshScheduleRequest$ScheduleId' => '

The ID of the refresh schedule.

', 'DeleteRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'DeleteRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRoleMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'DeleteTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteUserByPrincipalIdRequest$PrincipalId' => '

The principal ID of the user.

', 'DeleteUserByPrincipalIdResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSourcePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderPermissionsRequest$NextToken' => '

A pagination token for the next set of results.

', 'DescribeFolderPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderPermissionsResponse$NextToken' => '

The pagination token for the next set of results, or null if there are no more results.

', 'DescribeFolderResolvedPermissionsRequest$NextToken' => '

A pagination token for the next set of results.

', 'DescribeFolderResolvedPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderResolvedPermissionsResponse$NextToken' => '

A pagination token for the next set of results, or null if there are no more results.

', 'DescribeFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'DescribeIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIpRestrictionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeRefreshScheduleRequest$ScheduleId' => '

The ID of the refresh schedule.

', 'DescribeRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplatePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicRefreshResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'DescribeTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DestinationParameterValueConfiguration$SourceParameterName' => '

The source parameter name of the destination parameter.

', 'DomainNotWhitelistedException$Message' => NULL, 'DomainNotWhitelistedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ErrorInfo$Message' => '

Error message.

', 'FailedKeyRegistrationEntry$KeyArn' => '

The ARN of the KMS key that failed to update.

', 'FieldTooltipItem$Label' => '

The label of the tooltip item.

', 'FolderColumnList$member' => NULL, 'FolderSearchFilter$Value' => '

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".

', 'Font$FontFamily' => '

Determines the font family settings.

', 'ForecastComputation$Name' => '

The name of a computation.

', 'GenerateEmbedUrlForAnonymousUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GenerateEmbedUrlForRegisteredUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GetDashboardEmbedUrlResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GetSessionEmbedUrlResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'Group$PrincipalId' => '

The principal ID of the group.

', 'GroupSearchFilter$Value' => '

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

', 'GroupsList$member' => NULL, 'GrowthRateComputation$Name' => '

The name of a computation.

', 'IAMPolicyAssignment$AssignmentId' => '

Assignment ID.

', 'IdentityMap$key' => NULL, 'IdentityTypeNotSupportedException$Message' => NULL, 'IdentityTypeNotSupportedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InternalFailureException$Message' => NULL, 'InternalFailureException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidNextTokenException$Message' => NULL, 'InvalidNextTokenException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidParameterValueException$Message' => NULL, 'InvalidParameterValueException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidRequestException$Message' => NULL, 'InvalidRequestException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'LabelOptions$CustomLabel' => '

The text for the label.

', 'LimitExceededException$Message' => NULL, 'LimitExceededException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ListAnalysesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListAnalysesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListAnalysesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListAssetBundleExportJobsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleExportJobsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleImportJobsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleImportJobsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDashboardsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDataSetsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSetsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSetsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDataSourcesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSourcesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSourcesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListFolderMembersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFolderMembersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFolderMembersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListFoldersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFoldersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFoldersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListGroupMembershipsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupMembershipsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupMembershipsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIAMPolicyAssignmentsForUserRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsForUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIAMPolicyAssignmentsForUserResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIdentityPropagationConfigsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIdentityPropagationConfigsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIdentityPropagationConfigsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIngestionsRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'ListIngestionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIngestionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIngestionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListNamespacesRequest$NextToken' => '

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

', 'ListNamespacesResponse$NextToken' => '

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

', 'ListNamespacesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListRefreshSchedulesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListRoleMembershipsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListRoleMembershipsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListRoleMembershipsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTagsForResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplateAliasesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateAliasesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplateAliasesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplatesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplatesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplatesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemeAliasesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeAliasesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemeAliasesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicRefreshSchedulesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicReviewedAnswersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTopicsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTopicsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListUserGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUserGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUserGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListUsersRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUsersResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUsersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListVPCConnectionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListVPCConnectionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListVPCConnectionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'LookbackWindow$ColumnName' => '

The name of the lookback window column.

', 'MaximumMinimumComputation$Name' => '

The name of a computation.

', 'MetricComparisonComputation$Name' => '

The name of a computation.

', 'NamespaceError$Message' => '

The message for the error.

', 'NamespaceInfoV2$CapacityRegion' => '

The namespace Amazon Web Services Region.

', 'NetworkInterface$AvailabilityZone' => '

The availability zone that the network interface resides in.

', 'NetworkInterface$ErrorMessage' => '

An error message.

', 'ParameterSelectableValueList$member' => NULL, 'PeriodOverPeriodComputation$Name' => '

The name of a computation.

', 'PeriodToDateComputation$Name' => '

The name of a computation.

', 'PivotTableFieldCollapseStateTarget$FieldId' => '

The field ID of the pivot table that the collapse state needs to be set to.

', 'PivotTotalOptions$CustomLabel' => '

The custom label string for the total cells.

', 'PreconditionNotMetException$Message' => NULL, 'PreconditionNotMetException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'PrincipalList$member' => NULL, 'ProjectedColumnList$member' => NULL, 'PutDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'QueueInfo$WaitingOnIngestion' => '

The ID of the queued ingestion.

', 'QueueInfo$QueuedIngestion' => '

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

', 'QuickSightUserNotFoundException$Message' => NULL, 'QuickSightUserNotFoundException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'RefreshFrequency$Timezone' => '

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

', 'RefreshFrequency$TimeOfTheDay' => '

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

', 'RefreshSchedule$ScheduleId' => '

An identifier for the refresh schedule.

', 'RegisterUserRequest$Email' => '

The email address of the user that you want to register.

', 'RegisterUserRequest$IamArn' => '

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

', 'RegisterUserRequest$ExternalLoginFederationProviderType' => '

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.

', 'RegisterUserRequest$CustomFederationProviderUrl' => '

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.

', 'RegisterUserRequest$ExternalLoginId' => '

The identity ID for a user in the external login provider.

', 'RegisterUserResponse$UserInvitationUrl' => '

The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

', 'RegisterUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'RegisteredCustomerManagedKey$KeyArn' => '

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

', 'ResourceExistsException$Message' => NULL, 'ResourceExistsException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ResourceUnavailableException$Message' => NULL, 'ResourceUnavailableException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'RestoreAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'RowLevelPermissionTagRule$ColumnName' => '

The column name that a tag key is assigned to.

', 'SearchAnalysesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchAnalysesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchAnalysesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDashboardsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchDashboardsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchDashboardsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDataSetsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSetsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSetsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDataSourcesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSourcesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSourcesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchFoldersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchFoldersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchFoldersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SessionLifetimeInMinutesInvalidException$Message' => NULL, 'SessionLifetimeInMinutesInvalidException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'SignupResponse$userLoginName' => '

The user login name for your Amazon QuickSight account.

', 'SignupResponse$accountName' => '

The name of your Amazon QuickSight account.

', 'SignupResponse$directoryType' => '

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.

', 'SnapshotJobErrorInfo$ErrorMessage' => '

The error message.

', 'SnapshotJobErrorInfo$ErrorType' => '

The error type.

', 'SnapshotJobResultErrorInfo$ErrorMessage' => '

The error message.

', 'SnapshotJobResultErrorInfo$ErrorType' => '

The error type.

', 'StringList$member' => NULL, 'SubtotalOptions$CustomLabel' => '

The custom label string for the subtotal cells.

', 'SuccessfulKeyRegistrationEntry$KeyArn' => '

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

', 'TableFieldCustomTextContent$Value' => '

The string value of the custom text content for the table URL link content.

', 'TagResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ThrottlingException$Message' => NULL, 'ThrottlingException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'TopBottomMoversComputation$Name' => '

The name of a computation.

', 'TopBottomRankedComputation$Name' => '

The name of a computation.

', 'TotalAggregationComputation$Name' => '

The name of a computation.

', 'TotalOptions$CustomLabel' => '

The custom label string for the total cells.

', 'UniqueValuesComputation$Name' => '

The name of a computation.

', 'UnsupportedPricingPlanException$Message' => NULL, 'UnsupportedPricingPlanException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'UnsupportedUserEditionException$Message' => NULL, 'UnsupportedUserEditionException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'UntagResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAccountSettingsRequest$NotificationEmail' => '

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

', 'UpdateAccountSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAnalysisPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardLinksResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardPublishedVersionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSetPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSourcePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateFolderPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIAMPolicyAssignmentResponse$AssignmentId' => '

The ID of the assignment.

', 'UpdateIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIdentityPropagationConfigResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIpRestrictionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdatePublicSharingSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'UpdateRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateSPICECapacityConfigurationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplatePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'UpdateTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateUserRequest$Email' => '

The email address of the user that you want to update.

', 'UpdateUserRequest$ExternalLoginFederationProviderType' => '

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.

', 'UpdateUserRequest$CustomFederationProviderUrl' => '

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.

', 'UpdateUserRequest$ExternalLoginId' => '

The identity ID for a user in the external login provider.

', 'UpdateUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'User$Email' => '

The user\'s email address.

', 'User$PrincipalId' => '

The principal ID of the user.

', 'User$ExternalLoginFederationProviderType' => '

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

', 'User$ExternalLoginFederationProviderUrl' => '

The URL of the external login provider.

', 'User$ExternalLoginId' => '

The identity ID for the user in the external login provider.

', 'VPCConnection$VPCId' => '

The Amazon EC2 VPC ID associated with the VPC connection.

', 'VPCConnection$RoleArn' => '

The ARN of the IAM role associated with the VPC connection.

', 'VPCConnectionSummary$VPCId' => '

The Amazon EC2 VPC ID associated with the VPC connection.

', 'VPCConnectionSummary$RoleArn' => '

The ARN of the IAM role associated with the VPC connection.

', 'WaterfallChartOptions$TotalBarLabel' => '

This option determines the total bar label of a waterfall visual.

', ], ], 'StringDatasetParameter' => [ 'base' => '

A string parameter for a dataset.

', 'refs' => [ 'DatasetParameter$StringDatasetParameter' => '

A string parameter that is created in the dataset.

', ], ], 'StringDatasetParameterDefaultValue' => [ 'base' => '

The default value for the string parameter.

', 'refs' => [ 'StringDatasetParameterValueList$member' => NULL, ], ], 'StringDatasetParameterDefaultValues' => [ 'base' => '

The default values of a string parameter.

', 'refs' => [ 'StringDatasetParameter$DefaultValues' => '

A list of default values for a given string dataset parameter type. This structure only accepts static values.

', ], ], 'StringDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'NewDefaultValues$StringStaticValues' => '

A list of static default values for a given string parameter.

', 'StringDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given string parameter.

', ], ], 'StringDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$StringValues' => '

A list of string-type parameter values.

', 'StringDefaultValues$StaticValues' => '

The static values of the DecimalDefaultValues.

', ], ], 'StringDefaultValues' => [ 'base' => '

The default values of the StringParameterDeclaration.

', 'refs' => [ 'StringParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'StringFormatConfiguration' => [ 'base' => '

Formatting configuration for string fields.

', 'refs' => [ 'CategoricalDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'CategoricalMeasureField$FormatConfiguration' => '

The format configuration of the field.

', 'FormatConfiguration$StringFormatConfiguration' => '

Formatting configuration for string fields.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CellValueSynonym$Synonyms' => '

Other names or aliases for the cell value.

', 'CollectiveConstant$ValueList' => '

A list of values for the collective constant.

', 'ComparativeOrder$SpecifedOrder' => '

The list of columns to be used in the ordering.

', 'GenerateEmbedUrlForAnonymousUserRequest$AllowedDomains' => '

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.

', 'GenerateEmbedUrlForRegisteredUserRequest$AllowedDomains' => '

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.

', 'VPCConnection$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', 'VPCConnectionSummary$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', ], ], 'StringParameter' => [ 'base' => '

A string parameter.

', 'refs' => [ 'StringParameterList$member' => NULL, ], ], 'StringParameterDeclaration' => [ 'base' => '

A parameter declaration for the String data type.

', 'refs' => [ 'ParameterDeclaration$StringParameterDeclaration' => '

A parameter declaration for the String data type.

', ], ], 'StringParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$StringParameters' => '

The parameters that have a data type of string.

', ], ], 'StringValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a String parameter when a value has not been set.

', 'refs' => [ 'StringParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a String parameter when a value has not been set.

', ], ], 'StyledCellType' => [ 'base' => NULL, 'refs' => [ 'TableStyleTarget$CellType' => '

The cell type of the table style target.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$SubnetId' => '

The subnet ID associated with the network interface.

', 'SubnetIdList$member' => NULL, ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$SubnetIds' => '

A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.

', 'CreateVPCConnectionRequest$SubnetIds' => '

A list of subnet IDs for the VPC connection.

', 'UpdateVPCConnectionRequest$SubnetIds' => '

A list of subnet IDs for the VPC connection.

', ], ], 'SubtotalOptions' => [ 'base' => '

The subtotal options.

', 'refs' => [ 'PivotTableTotalOptions$RowSubtotalOptions' => '

The row subtotal options.

', 'PivotTableTotalOptions$ColumnSubtotalOptions' => '

The column subtotal options.

', ], ], 'SucceededTopicReviewedAnswer' => [ 'base' => '

The definition for a SucceededTopicReviewedAnswer.

', 'refs' => [ 'SucceededTopicReviewedAnswers$member' => NULL, ], ], 'SucceededTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$SucceededAnswers' => '

The definition of Answers that are successfully created.

', 'BatchDeleteTopicReviewedAnswerResponse$SucceededAnswers' => '

The definition of Answers that are successfully deleted.

', ], ], 'SuccessfulKeyRegistrationEntries' => [ 'base' => NULL, 'refs' => [ 'UpdateKeyRegistrationResponse$SuccessfulKeyRegistration' => '

A list of all customer managed key registrations that were successfully updated.

', ], ], 'SuccessfulKeyRegistrationEntry' => [ 'base' => '

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

', 'refs' => [ 'SuccessfulKeyRegistrationEntries$member' => NULL, ], ], 'Suffix' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the currency format.

', 'NumberDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the number format.

', 'PercentageDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the percentage format.

', ], ], 'Synonyms' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$CalculatedFieldSynonyms' => '

The other names or aliases for the calculated field.

', 'TopicColumn$ColumnSynonyms' => '

The other names or aliases for the column.

', 'TopicFilter$FilterSynonyms' => '

The other names or aliases for the filter.

', 'TopicNamedEntity$EntitySynonyms' => '

The other names or aliases for the named entity.

', ], ], 'TableAggregatedFieldWells' => [ 'base' => '

The aggregated field well for the table.

', 'refs' => [ 'TableFieldWells$TableAggregatedFieldWells' => '

The aggregated field well for the table.

', ], ], 'TableBorderOptions' => [ 'base' => '

The border options for a table border.

', 'refs' => [ 'GlobalTableBorderOptions$UniformBorder' => '

Determines the options for uniform border.

', 'TableSideBorderOptions$InnerVertical' => '

The table border options of the inner vertical border.

', 'TableSideBorderOptions$InnerHorizontal' => '

The table border options of the inner horizontal border.

', 'TableSideBorderOptions$Left' => '

The table border options of the left border.

', 'TableSideBorderOptions$Right' => '

The table border options of the right border.

', 'TableSideBorderOptions$Top' => '

The table border options of the top border.

', 'TableSideBorderOptions$Bottom' => '

The table border options of the bottom border.

', ], ], 'TableBorderStyle' => [ 'base' => NULL, 'refs' => [ 'TableBorderOptions$Style' => '

The style (none, solid) of a table border.

', ], ], 'TableBorderThickness' => [ 'base' => NULL, 'refs' => [ 'TableBorderOptions$Thickness' => '

The thickness of a table border.

', ], ], 'TableCellConditionalFormatting' => [ 'base' => '

The cell conditional formatting option for a table.

', 'refs' => [ 'TableConditionalFormattingOption$Cell' => '

The cell conditional formatting option for a table.

', ], ], 'TableCellImageScalingConfiguration' => [ 'base' => NULL, 'refs' => [ 'TableCellImageSizingConfiguration$TableCellImageScalingConfiguration' => '

The cell scaling configuration of the sizing options for the table image configuration.

', ], ], 'TableCellImageSizingConfiguration' => [ 'base' => '

The sizing options for the table image configuration.

', 'refs' => [ 'TableFieldImageConfiguration$SizingOptions' => '

The sizing options for the table image configuration.

', ], ], 'TableCellStyle' => [ 'base' => '

The table cell style for a cell in pivot table or table visual.

', 'refs' => [ 'PivotTableOptions$ColumnHeaderStyle' => '

The table cell style of the column header.

', 'PivotTableOptions$RowHeaderStyle' => '

The table cell style of the row headers.

', 'PivotTableOptions$CellStyle' => '

The table cell style of cells.

', 'PivotTableOptions$RowFieldNamesStyle' => '

The table cell style of row field names.

', 'PivotTotalOptions$TotalCellStyle' => '

The cell styling options for the total cells.

', 'PivotTotalOptions$ValueCellStyle' => '

The cell styling options for the totals of value cells.

', 'PivotTotalOptions$MetricHeaderCellStyle' => '

The cell styling options for the total of header cells.

', 'SubtotalOptions$TotalCellStyle' => '

The cell styling options for the subtotal cells.

', 'SubtotalOptions$ValueCellStyle' => '

The cell styling options for the subtotals of value cells.

', 'SubtotalOptions$MetricHeaderCellStyle' => '

The cell styling options for the subtotals of header cells.

', 'TableOptions$HeaderStyle' => '

The table cell style of a table header.

', 'TableOptions$CellStyle' => '

The table cell style of table cells.

', 'TotalOptions$TotalCellStyle' => '

Cell styling options for the total cells.

', ], ], 'TableConditionalFormatting' => [ 'base' => '

The conditional formatting for a PivotTableVisual.

', 'refs' => [ 'TableVisual$ConditionalFormatting' => '

The conditional formatting for a PivotTableVisual.

', ], ], 'TableConditionalFormattingOption' => [ 'base' => '

Conditional formatting options for a PivotTableVisual.

', 'refs' => [ 'TableConditionalFormattingOptionList$member' => NULL, ], ], 'TableConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'TableConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options for a PivotTableVisual.

', ], ], 'TableConfiguration' => [ 'base' => '

The configuration for a TableVisual.

', 'refs' => [ 'TableVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'TableFieldCustomIconContent' => [ 'base' => '

The custom icon content for the table link content configuration.

', 'refs' => [ 'TableFieldLinkContentConfiguration$CustomIconContent' => '

The custom icon content for the table link content configuration.

', ], ], 'TableFieldCustomTextContent' => [ 'base' => '

The custom text content (value, font configuration) for the table link content configuration.

', 'refs' => [ 'TableFieldLinkContentConfiguration$CustomTextContent' => '

The custom text content (value, font configuration) for the table link content configuration.

', ], ], 'TableFieldHeight' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$Height' => '

The height color for the table cells.

', ], ], 'TableFieldIconSetType' => [ 'base' => NULL, 'refs' => [ 'TableFieldCustomIconContent$Icon' => '

The icon set type (link) of the custom icon content for table URL link content.

', ], ], 'TableFieldImageConfiguration' => [ 'base' => '

The image configuration of a table field URL.

', 'refs' => [ 'TableFieldURLConfiguration$ImageConfiguration' => '

The image configuration of a table field URL.

', ], ], 'TableFieldLinkConfiguration' => [ 'base' => '

The link configuration of a table field URL.

', 'refs' => [ 'TableFieldURLConfiguration$LinkConfiguration' => '

The link configuration of a table field URL.

', ], ], 'TableFieldLinkContentConfiguration' => [ 'base' => '

The URL content (text, icon) for the table link configuration.

', 'refs' => [ 'TableFieldLinkConfiguration$Content' => '

The URL content (text, icon) for the table link configuration.

', ], ], 'TableFieldOption' => [ 'base' => '

The options for a table field.

', 'refs' => [ 'TableFieldOptionList$member' => NULL, ], ], 'TableFieldOptionList' => [ 'base' => NULL, 'refs' => [ 'TableFieldOptions$SelectedFieldOptions' => '

The field options to be configured to a table.

', ], ], 'TableFieldOptions' => [ 'base' => '

The field options of a table visual.

', 'refs' => [ 'TableConfiguration$FieldOptions' => '

The field options for a table visual.

', ], ], 'TableFieldOrderList' => [ 'base' => '

A list of table field IDs.

', 'refs' => [ 'TablePinnedFieldOptions$PinnedLeftFields' => '

A list of columns to be pinned to the left of a table visual.

', ], ], 'TableFieldURLConfiguration' => [ 'base' => '

The URL configuration for a table field.

', 'refs' => [ 'TableFieldOption$URLStyling' => '

The URL configuration for a table field.

', ], ], 'TableFieldWells' => [ 'base' => '

The field wells for a table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TableConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'TableInlineVisualization' => [ 'base' => '

The inline visualization of a specific type to display within a chart.

', 'refs' => [ 'TableInlineVisualizationList$member' => NULL, ], ], 'TableInlineVisualizationList' => [ 'base' => NULL, 'refs' => [ 'TableConfiguration$TableInlineVisualizations' => '

A collection of inline visualizations to display within a chart.

', ], ], 'TableOptions' => [ 'base' => '

The table options for a table visual.

', 'refs' => [ 'TableConfiguration$TableOptions' => '

The table options for a table visual.

', ], ], 'TableOrientation' => [ 'base' => NULL, 'refs' => [ 'TableOptions$Orientation' => '

The orientation (vertical, horizontal) for a table.

', ], ], 'TablePaginatedReportOptions' => [ 'base' => '

The paginated report options for a table visual.

', 'refs' => [ 'TableConfiguration$PaginatedReportOptions' => '

The paginated report options for a table visual.

', ], ], 'TablePinnedFieldOptions' => [ 'base' => '

The settings for the pinned columns of a table visual.

', 'refs' => [ 'TableFieldOptions$PinnedFieldOptions' => '

The settings for the pinned columns of a table visual.

', ], ], 'TableRowConditionalFormatting' => [ 'base' => '

The conditional formatting of a table row.

', 'refs' => [ 'TableConditionalFormattingOption$Row' => '

The row conditional formatting option for a table.

', ], ], 'TableSideBorderOptions' => [ 'base' => '

The side border options for a table.

', 'refs' => [ 'GlobalTableBorderOptions$SideSpecificBorder' => '

Determines the options for side specific border.

', ], ], 'TableSortConfiguration' => [ 'base' => '

The sort configuration for a TableVisual.

', 'refs' => [ 'TableConfiguration$SortConfiguration' => '

The sort configuration for a TableVisual.

', ], ], 'TableStyleTarget' => [ 'base' => '

The table style target.

', 'refs' => [ 'TableStyleTargetList$member' => NULL, ], ], 'TableStyleTargetList' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$StyleTargets' => '

The style targets options for subtotals.

', ], ], 'TableTotalsPlacement' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$Placement' => '

The placement (start, end) for the total cells.

', 'TotalOptions$Placement' => '

The placement (start, end) for the total cells.

', ], ], 'TableTotalsScrollStatus' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$ScrollStatus' => '

The scroll status (pinned, scrolled) for the total cells.

', 'TotalOptions$ScrollStatus' => '

The scroll status (pinned, scrolled) for the total cells.

', ], ], 'TableUnaggregatedFieldWells' => [ 'base' => '

The unaggregated field well for the table.

', 'refs' => [ 'TableFieldWells$TableUnaggregatedFieldWells' => '

The unaggregated field well for the table.

', ], ], 'TableVisual' => [ 'base' => '

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$TableVisual' => '

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

', ], ], 'Tag' => [ 'base' => '

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagColumnOperation' => [ 'base' => '

A transform operation that tags a column with additional information.

', 'refs' => [ 'TransformOperation$TagColumnOperation' => '

An operation that tags a column with additional information.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

Tag key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideTags$Tags' => '

A list of tags for the analyses that you want to apply overrides to.

', 'AssetBundleImportJobDashboardOverrideTags$Tags' => '

A list of tags for the dashboards that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverrideTags$Tags' => '

A list of tags for the datasets that you want to apply overrides to.

', 'AssetBundleImportJobDataSourceOverrideTags$Tags' => '

A list of tags for the data source that you want to apply overrides to.

', 'AssetBundleImportJobThemeOverrideTags$Tags' => '

A list of tags for the themes that you want to apply overrides to.

', 'AssetBundleImportJobVPCConnectionOverrideTags$Tags' => '

A list of tags for the VPC connections that you want to apply overrides to.

', 'CreateAccountCustomizationRequest$Tags' => '

A list of the tags that you want to attach to this resource.

', 'CreateAnalysisRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

', 'CreateDashboardRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

', 'CreateDataSetRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

', 'CreateDataSourceRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

', 'CreateFolderRequest$Tags' => '

Tags for the folder.

', 'CreateNamespaceRequest$Tags' => '

The tags that you want to associate with the namespace that you\'re creating.

', 'CreateTemplateRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', 'CreateThemeRequest$Tags' => '

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

', 'CreateTopicRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.

', 'CreateVPCConnectionRequest$Tags' => '

A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

', 'ListTagsForResourceResponse$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', 'RegisterUserRequest$Tags' => '

The tags to associate with the user.

', 'TagResourceRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Tag value.

', ], ], 'TargetVisualList' => [ 'base' => NULL, 'refs' => [ 'SameSheetTargetVisualConfiguration$TargetVisuals' => '

A list of the target visual IDs that are located in the same sheet of the analysis.

', ], ], 'TargetVisualOptions' => [ 'base' => NULL, 'refs' => [ 'SameSheetTargetVisualConfiguration$TargetVisualOptions' => '

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

', ], ], 'Template' => [ 'base' => '

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.

', 'refs' => [ 'DescribeTemplateResponse$Template' => '

The template structure for the object you want to describe.

', ], ], 'TemplateAlias' => [ 'base' => '

The template alias.

', 'refs' => [ 'CreateTemplateAliasResponse$TemplateAlias' => '

Information about the template alias.

', 'DescribeTemplateAliasResponse$TemplateAlias' => '

Information about the template alias.

', 'TemplateAliasList$member' => NULL, 'UpdateTemplateAliasResponse$TemplateAlias' => '

The template alias.

', ], ], 'TemplateAliasList' => [ 'base' => NULL, 'refs' => [ 'ListTemplateAliasesResponse$TemplateAliasList' => '

A structure containing the list of the template\'s aliases.

', ], ], 'TemplateError' => [ 'base' => '

List of errors that occurred when the template version creation failed.

', 'refs' => [ 'TemplateErrorList$member' => NULL, ], ], 'TemplateErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeTemplateDefinitionResponse$Errors' => '

Errors associated with the template version.

', 'TemplateVersion$Errors' => '

Errors associated with this template version.

', ], ], 'TemplateErrorType' => [ 'base' => NULL, 'refs' => [ 'TemplateError$Type' => '

Type of error.

', ], ], 'TemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateRequest$Name' => '

A display name for the template.

', 'DescribeTemplateDefinitionResponse$Name' => '

The descriptive name of the template.

', 'Template$Name' => '

The display name of the template.

', 'TemplateSummary$Name' => '

A display name for the template.

', 'UpdateTemplateRequest$Name' => '

The name for the template.

', ], ], 'TemplateSourceAnalysis' => [ 'base' => '

The source analysis of the template.

', 'refs' => [ 'TemplateSourceEntity$SourceAnalysis' => '

The source analysis, if it is based on an analysis.

', ], ], 'TemplateSourceEntity' => [ 'base' => '

The source entity of the template.

', 'refs' => [ 'CreateTemplateRequest$SourceEntity' => '

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.

', 'UpdateTemplateRequest$SourceEntity' => '

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.

', ], ], 'TemplateSourceTemplate' => [ 'base' => '

The source template of the template.

', 'refs' => [ 'TemplateSourceEntity$SourceTemplate' => '

The source template, if it is based on an template.

', ], ], 'TemplateSummary' => [ 'base' => '

The template summary.

', 'refs' => [ 'TemplateSummaryList$member' => NULL, ], ], 'TemplateSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTemplatesResponse$TemplateSummaryList' => '

A structure containing information about the templates in the list.

', ], ], 'TemplateVersion' => [ 'base' => '

A version of a template.

', 'refs' => [ 'Template$Version' => '

A structure describing the versions of the template.

', ], ], 'TemplateVersionDefinition' => [ 'base' => '

The detailed definition of a template.

', 'refs' => [ 'CreateTemplateRequest$Definition' => '

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeTemplateDefinitionResponse$Definition' => '

The definition of the template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateTemplateRequest$Definition' => '

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'TemplateVersionSummary' => [ 'base' => '

The template version.

', 'refs' => [ 'TemplateVersionSummaryList$member' => NULL, ], ], 'TemplateVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTemplateVersionsResponse$TemplateVersionSummaryList' => '

A structure containing a list of all the versions of the specified template.

', ], ], 'TeradataParameters' => [ 'base' => '

The parameters for Teradata.

', 'refs' => [ 'DataSourceParameters$TeradataParameters' => '

The parameters for Teradata.

', ], ], 'TextAreaControlDelimiter' => [ 'base' => NULL, 'refs' => [ 'DefaultTextAreaControlOptions$Delimiter' => '

The delimiter that is used to separate the lines in text.

', 'FilterTextAreaControl$Delimiter' => '

The delimiter that is used to separate the lines in text.

', 'ParameterTextAreaControl$Delimiter' => '

The delimiter that is used to separate the lines in text.

', ], ], 'TextAreaControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultTextAreaControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterTextAreaControl$DisplayOptions' => '

The display options of a control.

', 'ParameterTextAreaControl$DisplayOptions' => '

The display options of a control.

', ], ], 'TextConditionalFormat' => [ 'base' => '

The conditional formatting for the text.

', 'refs' => [ 'PivotTableCellConditionalFormatting$TextFormat' => '

The text format of the cell for conditional formatting.

', 'TableCellConditionalFormatting$TextFormat' => '

The text format of the cell for conditional formatting.

', ], ], 'TextControlPlaceholderOptions' => [ 'base' => '

The configuration of the placeholder options in a text control.

', 'refs' => [ 'TextAreaControlDisplayOptions$PlaceholderOptions' => '

The configuration of the placeholder options in a text area control.

', 'TextFieldControlDisplayOptions$PlaceholderOptions' => '

The configuration of the placeholder options in a text field control.

', ], ], 'TextFieldControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultTextFieldControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterTextFieldControl$DisplayOptions' => '

The display options of a control.

', 'ParameterTextFieldControl$DisplayOptions' => '

The display options of a control.

', ], ], 'TextQualifier' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$TextQualifier' => '

Text qualifier.

', ], ], 'TextWrap' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$TextWrap' => '

The text wrap (none, wrap) for the table cells.

', ], ], 'Theme' => [ 'base' => '

Summary information about a theme.

', 'refs' => [ 'DescribeThemeResponse$Theme' => '

The information about the theme that you are describing.

', ], ], 'ThemeAlias' => [ 'base' => '

An alias for a theme.

', 'refs' => [ 'CreateThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', 'DescribeThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', 'ThemeAliasList$member' => NULL, 'UpdateThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', ], ], 'ThemeAliasList' => [ 'base' => NULL, 'refs' => [ 'ListThemeAliasesResponse$ThemeAliasList' => '

A structure containing the list of the theme\'s aliases.

', ], ], 'ThemeConfiguration' => [ 'base' => '

The theme configuration. This configuration contains all of the display properties for a theme.

', 'refs' => [ 'CreateThemeRequest$Configuration' => '

The theme configuration, which contains the theme display properties.

', 'ThemeVersion$Configuration' => '

The theme configuration, which contains all the theme display properties.

', 'UpdateThemeRequest$Configuration' => '

The theme configuration, which contains the theme display properties.

', ], ], 'ThemeError' => [ 'base' => '

Theme error.

', 'refs' => [ 'ThemeErrorList$member' => NULL, ], ], 'ThemeErrorList' => [ 'base' => NULL, 'refs' => [ 'ThemeVersion$Errors' => '

Errors associated with the theme.

', ], ], 'ThemeErrorType' => [ 'base' => NULL, 'refs' => [ 'ThemeError$Type' => '

The type of error.

', ], ], 'ThemeName' => [ 'base' => NULL, 'refs' => [ 'CreateThemeRequest$Name' => '

A display name for the theme.

', 'Theme$Name' => '

The name that the user gives to the theme.

', 'ThemeSummary$Name' => '

the display name for the theme.

', 'UpdateThemeRequest$Name' => '

The name for the theme.

', ], ], 'ThemeSummary' => [ 'base' => '

The theme summary.

', 'refs' => [ 'ThemeSummaryList$member' => NULL, ], ], 'ThemeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListThemesResponse$ThemeSummaryList' => '

Information about the themes in the list.

', ], ], 'ThemeType' => [ 'base' => NULL, 'refs' => [ 'ListThemesRequest$Type' => '

The type of themes that you want to list. Valid options include the following:

', 'Theme$Type' => '

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

', ], ], 'ThemeVersion' => [ 'base' => '

A version of a theme.

', 'refs' => [ 'Theme$Version' => NULL, ], ], 'ThemeVersionSummary' => [ 'base' => '

The theme version.

', 'refs' => [ 'ThemeVersionSummaryList$member' => NULL, ], ], 'ThemeVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListThemeVersionsResponse$ThemeVersionSummaryList' => '

A structure containing a list of all the versions of the specified theme.

', ], ], 'ThousandSeparatorOptions' => [ 'base' => '

The options that determine the thousands separator configuration.

', 'refs' => [ 'NumericSeparatorConfiguration$ThousandsSeparator' => '

The options that determine the thousands separator configuration.

', ], ], 'ThrottlingException' => [ 'base' => '

Access is throttled.

', 'refs' => [], ], 'TileLayoutStyle' => [ 'base' => '

The display options for the layout of tiles on a sheet.

', 'refs' => [ 'SheetStyle$TileLayout' => '

The layout options for tiles.

', ], ], 'TileStyle' => [ 'base' => '

Display options related to tiles on a sheet.

', 'refs' => [ 'SheetStyle$Tile' => '

The display options for tiles.

', ], ], 'TimeBasedForecastProperties' => [ 'base' => '

The forecast properties setup of a forecast in the line chart.

', 'refs' => [ 'ForecastConfiguration$ForecastProperties' => '

The forecast properties setup of a forecast in the line chart.

', ], ], 'TimeEqualityFilter' => [ 'base' => '

A TimeEqualityFilter filters values that are equal to a given value.

', 'refs' => [ 'Filter$TimeEqualityFilter' => '

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

', ], ], 'TimeGranularity' => [ 'base' => NULL, 'refs' => [ 'AggregationPartitionBy$TimeGranularity' => '

The TimeGranularity for an AggregationPartitionBy.

', 'Anchor$TimeGranularity' => '

The TimeGranularity of the Anchor.

', 'DataPathColor$TimeGranularity' => '

The time granularity of the field that the color needs to be applied to.

', 'DateDimensionField$DateGranularity' => '

The date granularity of the DateDimensionField. Choose one of the following options:

', 'DateTimeDatasetParameter$TimeGranularity' => '

The time granularity of the date time parameter.

', 'DateTimeParameterDeclaration$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'ExcludePeriodConfiguration$Granularity' => '

The granularity or unit (day, month, year) of the exclude period.

', 'PeriodToDateComputation$PeriodTimeGranularity' => '

The time granularity setup of period to date computation. Choose from the following options:

', 'RelativeDatesFilter$MinimumGranularity' => '

The minimum granularity (period granularity) of the relative dates filter.

', 'RelativeDatesFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeEqualityFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeRangeDrillDownFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeRangeFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopBottomFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicIRFilterOption$TimeGranularity' => '

The time granularity for the TopicIRFilterOption.

', ], ], 'TimeRangeDrillDownFilter' => [ 'base' => '

The time range drill down filter.

', 'refs' => [ 'DrillDownFilter$TimeRangeFilter' => '

The time range drill down filter. This filter is used for date time columns.

', ], ], 'TimeRangeFilter' => [ 'base' => '

A TimeRangeFilter filters values that are between two specified values.

', 'refs' => [ 'Filter$TimeRangeFilter' => '

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

', ], ], 'TimeRangeFilterValue' => [ 'base' => '

The value of a time range filter.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TimeRangeFilter$RangeMinimumValue' => '

The minimum value for the filter value range.

', 'TimeRangeFilter$RangeMaximumValue' => '

The maximum value for the filter value range.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Analysis$CreatedTime' => '

The time that the analysis was created.

', 'Analysis$LastUpdatedTime' => '

The time that the analysis was last updated.

', 'AnalysisSummary$CreatedTime' => '

The time that the analysis was created.

', 'AnalysisSummary$LastUpdatedTime' => '

The time that the analysis was last updated.

', 'AssetBundleExportJobSummary$CreatedTime' => '

The time that the export job was created.

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$StartAfterDateTime' => '

An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.

', 'AssetBundleImportJobSummary$CreatedTime' => '

The time that the import job was created.

', 'Dashboard$CreatedTime' => '

The time that this dashboard was created.

', 'Dashboard$LastPublishedTime' => '

The last time that this dashboard was published.

', 'Dashboard$LastUpdatedTime' => '

The last time that this dashboard was updated.

', 'DashboardSummary$CreatedTime' => '

The time that this dashboard was created.

', 'DashboardSummary$LastUpdatedTime' => '

The last time that this dashboard was updated.

', 'DashboardSummary$LastPublishedTime' => '

The last time that this dashboard was published.

', 'DashboardVersion$CreatedTime' => '

The time that this dashboard version was created.

', 'DashboardVersionSummary$CreatedTime' => '

The time that this dashboard version was created.

', 'DataSet$CreatedTime' => '

The time that this dataset was created.

', 'DataSet$LastUpdatedTime' => '

The last time that this dataset was updated.

', 'DataSetSummary$CreatedTime' => '

The time that this dataset was created.

', 'DataSetSummary$LastUpdatedTime' => '

The last time that this dataset was updated.

', 'DataSource$CreatedTime' => '

The time that this data source was created.

', 'DataSource$LastUpdatedTime' => '

The last time that this data source was updated.

', 'DataSourceSummary$CreatedTime' => '

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

', 'DataSourceSummary$LastUpdatedTime' => '

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

', 'DeleteAnalysisResponse$DeletionTime' => '

The date and time that the analysis is scheduled to be deleted.

', 'DescribeAssetBundleExportJobResponse$CreatedTime' => '

The time that the export job was created.

', 'DescribeAssetBundleImportJobResponse$CreatedTime' => '

The time that the import job was created.

', 'DescribeDashboardSnapshotJobResponse$CreatedTime' => '

The time that the snapshot job was created.

', 'DescribeDashboardSnapshotJobResponse$LastUpdatedTime' => '

The time that the snapshot job status was last updated.

', 'DescribeDashboardSnapshotJobResultResponse$CreatedTime' => '

The time that a snapshot job was created.

', 'DescribeDashboardSnapshotJobResultResponse$LastUpdatedTime' => '

The time that a snapshot job status was last updated.

', 'Folder$CreatedTime' => '

The time that the folder was created.

', 'Folder$LastUpdatedTime' => '

The time that the folder was last updated.

', 'FolderSummary$CreatedTime' => '

The time that the folder was created.

', 'FolderSummary$LastUpdatedTime' => '

The time that the folder was last updated.

', 'Ingestion$CreatedTime' => '

The time that this ingestion started.

', 'RefreshSchedule$StartAfterDateTime' => '

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

', 'Template$LastUpdatedTime' => '

Time when this was last updated.

', 'Template$CreatedTime' => '

Time when this was created.

', 'TemplateSummary$CreatedTime' => '

The last time that this template was created.

', 'TemplateSummary$LastUpdatedTime' => '

The last time that this template was updated.

', 'TemplateVersion$CreatedTime' => '

The time that this template version was created.

', 'TemplateVersionSummary$CreatedTime' => '

The time that this template version was created.

', 'Theme$CreatedTime' => '

The date and time that the theme was created.

', 'Theme$LastUpdatedTime' => '

The date and time that the theme was last updated.

', 'ThemeSummary$CreatedTime' => '

The date and time that this theme was created.

', 'ThemeSummary$LastUpdatedTime' => '

The last date and time that this theme was updated.

', 'ThemeVersion$CreatedTime' => '

The date and time that this theme version was created.

', 'ThemeVersionSummary$CreatedTime' => '

The date and time that this theme version was created.

', 'TimeEqualityFilter$Value' => '

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName.

', 'TimeRangeDrillDownFilter$RangeMinimum' => '

The minimum value for the filter value range.

', 'TimeRangeDrillDownFilter$RangeMaximum' => '

The maximum value for the filter value range.

', 'TimeRangeFilterValue$StaticValue' => '

The static input value.

', 'TopicRefreshSchedule$StartingAt' => '

The starting date and time for the refresh schedule.

', 'VPCConnection$CreatedTime' => '

The time that the VPC connection was created.

', 'VPCConnection$LastUpdatedTime' => '

The time that the VPC connection was last updated.

', 'VPCConnectionSummary$CreatedTime' => '

The time that the VPC connection was created.

', 'VPCConnectionSummary$LastUpdatedTime' => '

The time that the VPC connection was last updated.

', 'WhatIfPointScenario$Date' => '

The date that you need the forecast results for.

', 'WhatIfRangeScenario$StartDate' => '

The start date in the date range that you need the forecast results for.

', 'WhatIfRangeScenario$EndDate' => '

The end date in the date range that you need the forecast results for.

', ], ], 'TooltipItem' => [ 'base' => '

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TooltipItemList$member' => NULL, ], ], 'TooltipItemList' => [ 'base' => NULL, 'refs' => [ 'FieldBasedTooltip$TooltipFields' => '

The fields configuration in the tooltip.

', ], ], 'TooltipOptions' => [ 'base' => '

The display options for the visual tooltip.

', 'refs' => [ 'BarChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'BoxPlotChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'ComboChartConfiguration$Tooltip' => '

The legend display setup of the visual.

', 'FilledMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'FunnelChartConfiguration$Tooltip' => '

The tooltip configuration of a FunnelChartVisual.

', 'GaugeChartConfiguration$TooltipOptions' => '

The tooltip configuration of a GaugeChartVisual.

', 'GeospatialMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'HeatMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'HistogramConfiguration$Tooltip' => '

The tooltip configuration of a histogram.

', 'LineChartConfiguration$Tooltip' => '

The tooltip configuration of a line chart.

', 'PieChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'ScatterPlotConfiguration$Tooltip' => '

The legend display setup of the visual.

', 'TreeMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', ], ], 'TooltipTarget' => [ 'base' => NULL, 'refs' => [ 'ColumnTooltipItem$TooltipTarget' => '

Determines the target of the column tooltip item in a combo chart visual.

', 'FieldTooltipItem$TooltipTarget' => '

Determines the target of the field tooltip item in a combo chart visual.

', ], ], 'TooltipTitleType' => [ 'base' => NULL, 'refs' => [ 'FieldBasedTooltip$TooltipTitleType' => '

The type for the >tooltip title. Choose one of the following options:

', ], ], 'TopBottomComputationType' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$Type' => '

The computation type. Choose from the following options:

', 'TopBottomRankedComputation$Type' => '

The computation type. Choose one of the following options:

', ], ], 'TopBottomFilter' => [ 'base' => '

A TopBottomFilter filters values that are at the top or the bottom.

', 'refs' => [ 'Filter$TopBottomFilter' => '

A TopBottomFilter filters data to the top or bottom values for a given column.

', ], ], 'TopBottomMoversComputation' => [ 'base' => '

The top movers and bottom movers computation setup.

', 'refs' => [ 'Computation$TopBottomMovers' => '

The top movers and bottom movers computation configuration.

', ], ], 'TopBottomMoversComputationMoverSize' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$MoverSize' => '

The mover size setup of the top and bottom movers computation.

', ], ], 'TopBottomRankedComputation' => [ 'base' => '

The top ranked and bottom ranked computation configuration.

', 'refs' => [ 'Computation$TopBottomRanked' => '

The top ranked and bottom ranked computation configuration.

', ], ], 'TopBottomRankedComputationResultSize' => [ 'base' => NULL, 'refs' => [ 'TopBottomRankedComputation$ResultSize' => '

The result size of a top and bottom ranked computation.

', ], ], 'TopBottomSortOrder' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$SortOrder' => '

The sort order setup of the top and bottom movers computation.

', ], ], 'TopicCalculatedField' => [ 'base' => '

A structure that represents a calculated field.

', 'refs' => [ 'TopicCalculatedFields$member' => NULL, ], ], 'TopicCalculatedFields' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$CalculatedFields' => '

The list of calculated field definitions.

', ], ], 'TopicCategoryFilter' => [ 'base' => '

A structure that represents a category filter.

', 'refs' => [ 'TopicFilter$CategoryFilter' => '

The category filter that is associated with this filter.

', ], ], 'TopicCategoryFilterConstant' => [ 'base' => '

A constant used in a category filter.

', 'refs' => [ 'TopicCategoryFilter$Constant' => '

The constant used in a category filter.

', ], ], 'TopicColumn' => [ 'base' => '

Represents a column in a dataset.

', 'refs' => [ 'TopicColumns$member' => NULL, ], ], 'TopicColumns' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$Columns' => '

The list of column definitions.

', ], ], 'TopicConstantValue' => [ 'base' => '

The definition for a TopicConstantValue.

', 'refs' => [ 'TopicIRFilterOption$Constant' => '

The constant for the TopicIRFilterOption.

', 'TopicIRFilterOption$Range' => '

The range for the TopicIRFilterOption.

', 'TopicIRFilterOption$LastNextOffset' => '

The last next offset for the TopicIRFilterOption.

', 'TopicIRFilterOption$TopBottomLimit' => '

The TopBottomLimit for the TopicIRFilterOption.

', ], ], 'TopicDateRangeFilter' => [ 'base' => '

A filter used to restrict data based on a range of dates or times.

', 'refs' => [ 'TopicFilter$DateRangeFilter' => '

The date range filter.

', ], ], 'TopicDetails' => [ 'base' => '

A structure that describes the details of a topic, such as its name, description, and associated data sets.

', 'refs' => [ 'CreateTopicRequest$Topic' => '

The definition of a topic to create.

', 'DescribeTopicResponse$Topic' => '

The definition of a topic.

', 'UpdateTopicRequest$Topic' => '

The definition of the topic that you want to update.

', ], ], 'TopicFilter' => [ 'base' => '

A structure that represents a filter used to select items for a topic.

', 'refs' => [ 'TopicFilters$member' => NULL, ], ], 'TopicFilters' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$Filters' => '

The list of filter definitions.

', ], ], 'TopicIR' => [ 'base' => '

The definition for a TopicIR.

', 'refs' => [ 'CreateTopicReviewedAnswer$Mir' => '

The Mir for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$Mir' => '

The mir for the TopicReviewedAnswer.

', 'TopicVisual$Ir' => '

The ir for the TopicVisual.

', ], ], 'TopicIRComparisonMethod' => [ 'base' => '

The definition of a TopicIRComparisonMethod.

', 'refs' => [ 'TopicIRMetric$ComparisonMethod' => '

The comparison method for the TopicIRMetric.

', ], ], 'TopicIRContributionAnalysis' => [ 'base' => '

The definition for a TopicIRContributionAnalysis.

', 'refs' => [ 'TopicIR$ContributionAnalysis' => '

The contribution analysis for the TopicIR.

', ], ], 'TopicIRFilterEntry' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterList$member' => NULL, ], ], 'TopicIRFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$Function' => '

The function for the TopicIRFilterOption.

', ], ], 'TopicIRFilterList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$Filters' => '

The filters for the TopicIR.

', ], ], 'TopicIRFilterOption' => [ 'base' => '

The definition for a TopicIRFilterOption.

', 'refs' => [ 'ContributionAnalysisTimeRanges$StartRange' => '

The start range for the ContributionAnalysisTimeRanges.

', 'ContributionAnalysisTimeRanges$EndRange' => '

The end range for the ContributionAnalysisTimeRanges.

', 'TopicIRFilterEntry$member' => NULL, ], ], 'TopicIRFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$FilterType' => '

The filter type for the TopicIRFilterOption.

', ], ], 'TopicIRGroupBy' => [ 'base' => '

The definition for a TopicIRGroupBy.

', 'refs' => [ 'TopicIRGroupByList$member' => NULL, ], ], 'TopicIRGroupByList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$GroupByList' => '

The GroupBy list for the TopicIR.

', ], ], 'TopicIRMetric' => [ 'base' => '

The definition for a TopicIRMetric.

', 'refs' => [ 'TopicIRMetricList$member' => NULL, ], ], 'TopicIRMetricList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$Metrics' => '

The metrics for the TopicIR.

', ], ], 'TopicId' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$TopicId' => '

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchCreateTopicReviewedAnswerResponse$TopicId' => '

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchDeleteTopicReviewedAnswerRequest$TopicId' => '

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchDeleteTopicReviewedAnswerResponse$TopicId' => '

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRequest$TopicId' => '

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicResponse$TopicId' => '

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRequest$TopicId' => '

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicResponse$TopicId' => '

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicPermissionsRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicPermissionsResponse$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicResponse$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicRefreshSchedulesRequest$TopicId' => '

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicRefreshSchedulesResponse$TopicId' => '

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicReviewedAnswersRequest$TopicId' => '

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicReviewedAnswersResponse$TopicId' => '

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'TopicSummary$TopicId' => '

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicPermissionsRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicPermissionsResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', ], ], 'TopicNamedEntities' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$NamedEntities' => '

The list of named entities definitions.

', ], ], 'TopicNamedEntity' => [ 'base' => '

A structure that represents a named entity.

', 'refs' => [ 'TopicNamedEntities$member' => NULL, ], ], 'TopicNumericEqualityFilter' => [ 'base' => '

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

', 'refs' => [ 'TopicFilter$NumericEqualityFilter' => '

The numeric equality filter.

', ], ], 'TopicNumericRangeFilter' => [ 'base' => '

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

', 'refs' => [ 'TopicFilter$NumericRangeFilter' => '

The numeric range filter.

', ], ], 'TopicNumericSeparatorSymbol' => [ 'base' => NULL, 'refs' => [ 'DisplayFormatOptions$DecimalSeparator' => '

Determines the decimal separator.

', ], ], 'TopicRangeFilterConstant' => [ 'base' => '

A constant value that is used in a range filter to specify the endpoints of the range.

', 'refs' => [ 'TopicDateRangeFilter$Constant' => '

The constant used in a date range filter.

', 'TopicNumericRangeFilter$Constant' => '

The constant used in a numeric range filter.

', ], ], 'TopicRefreshDetails' => [ 'base' => '

The details about the refresh of a topic.

', 'refs' => [ 'DescribeTopicRefreshResponse$RefreshDetails' => '

Details of the refresh, which is performed when the topic is created or updated.

', ], ], 'TopicRefreshSchedule' => [ 'base' => '

A structure that represents a topic refresh schedule.

', 'refs' => [ 'CreateTopicRefreshScheduleRequest$RefreshSchedule' => '

The definition of a refresh schedule.

', 'DescribeTopicRefreshScheduleResponse$RefreshSchedule' => '

The definition of a refresh schedule.

', 'TopicRefreshScheduleSummary$RefreshSchedule' => '

The definition of a refresh schedule.

', 'UpdateTopicRefreshScheduleRequest$RefreshSchedule' => '

The definition of a refresh schedule.

', ], ], 'TopicRefreshScheduleSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicRefreshSchedulesResponse$RefreshSchedules' => '

The list of topic refresh schedules.

', ], ], 'TopicRefreshScheduleSummary' => [ 'base' => '

A summary of the refresh schedule details for a dataset.

', 'refs' => [ 'TopicRefreshScheduleSummaries$member' => NULL, ], ], 'TopicRefreshStatus' => [ 'base' => NULL, 'refs' => [ 'TopicRefreshDetails$RefreshStatus' => '

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

', ], ], 'TopicRelativeDateFilter' => [ 'base' => '

A structure that represents a relative date filter.

', 'refs' => [ 'TopicFilter$RelativeDateFilter' => '

The relative date filter.

', ], ], 'TopicRelativeDateFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicRelativeDateFilter$RelativeDateFilterFunction' => '

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

', ], ], 'TopicReviewedAnswer' => [ 'base' => '

The deinition for a TopicReviewedAnswer.

', 'refs' => [ 'TopicReviewedAnswers$member' => NULL, ], ], 'TopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'ListTopicReviewedAnswersResponse$Answers' => '

The definition of all Answers in the topic.

', ], ], 'TopicScheduleType' => [ 'base' => NULL, 'refs' => [ 'TopicRefreshSchedule$TopicScheduleType' => '

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

', ], ], 'TopicSingularFilterConstant' => [ 'base' => '

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

', 'refs' => [ 'TopicNumericEqualityFilter$Constant' => '

The constant used in a numeric equality filter.

', 'TopicRelativeDateFilter$Constant' => '

The constant used in a relative date filter.

', ], ], 'TopicSortClause' => [ 'base' => '

The definition for a TopicSortClause.

', 'refs' => [ 'TopicIR$Sort' => '

The sort for the TopicIR.

', 'TopicIRGroupBy$Sort' => '

The sort for the TopicIRGroupBy.

', ], ], 'TopicSortDirection' => [ 'base' => NULL, 'refs' => [ 'FilterAggMetrics$SortDirection' => '

The sort direction for FilterAggMetrics.

', 'TopicIRFilterOption$SortDirection' => '

The sort direction for the TopicIRFilterOption.

', 'TopicSortClause$SortDirection' => '

The sort direction for the TopicSortClause.

', ], ], 'TopicSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicsResponse$TopicsSummaries' => '

A list of topic summaries.

', ], ], 'TopicSummary' => [ 'base' => '

A topic summary.

', 'refs' => [ 'TopicSummaries$member' => NULL, ], ], 'TopicTemplate' => [ 'base' => '

The definition for a TopicTemplate.

', 'refs' => [ 'CreateTopicReviewedAnswer$Template' => '

The template for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$Template' => '

The template for the TopicReviewedAnswer.

', ], ], 'TopicTimeGranularity' => [ 'base' => NULL, 'refs' => [ 'AggFunction$Period' => '

The period of an Agg function.

', 'DataAggregation$DatasetRowDateGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicCalculatedField$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicColumn$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicIRComparisonMethod$Period' => '

The period for the TopicIRComparisonMethod.

', 'TopicIRGroupBy$TimeGranularity' => '

The time granularity for the TopicIRGroupBy.

', 'TopicRelativeDateFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', ], ], 'TopicUserExperienceVersion' => [ 'base' => NULL, 'refs' => [ 'TopicDetails$UserExperienceVersion' => '

The user experience version of a topic.

', 'TopicSummary$UserExperienceVersion' => '

The user experience version of the topic.

', ], ], 'TopicVisual' => [ 'base' => '

The definition for a TopicVisual.

', 'refs' => [ 'CreateTopicReviewedAnswer$PrimaryVisual' => '

The PrimaryVisual for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$PrimaryVisual' => '

The primary visual for the TopicReviewedAnswer.

', 'TopicVisuals$member' => NULL, ], ], 'TopicVisuals' => [ 'base' => NULL, 'refs' => [ 'TopicVisual$SupportingVisuals' => '

The supporting visuals for the TopicVisual.

', ], ], 'TotalAggregationComputation' => [ 'base' => '

The total aggregation computation configuration.

', 'refs' => [ 'Computation$TotalAggregation' => '

The total aggregation computation configuration.

', ], ], 'TotalAggregationFunction' => [ 'base' => '

An aggregation function that aggregates the total values of a measure.

', 'refs' => [ 'TotalAggregationOption$TotalAggregationFunction' => '

The total aggregation function that you want to set for a specified field id.

', ], ], 'TotalAggregationOption' => [ 'base' => '

The total aggregation settings map of a field id.

', 'refs' => [ 'TotalAggregationOptionList$member' => NULL, ], ], 'TotalAggregationOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$TotalAggregationOptions' => '

The total aggregation options for each value field.

', 'TotalOptions$TotalAggregationOptions' => '

The total aggregation settings for each value field.

', ], ], 'TotalOptions' => [ 'base' => '

The total options for a table visual.

', 'refs' => [ 'TableConfiguration$TotalOptions' => '

The total options for a table visual.

', ], ], 'TransformOperation' => [ 'base' => '

A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'TransformOperationList$member' => NULL, ], ], 'TransformOperationList' => [ 'base' => NULL, 'refs' => [ 'LogicalTable$DataTransforms' => '

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

', ], ], 'TreeMapAggregatedFieldWells' => [ 'base' => '

Aggregated field wells of a tree map.

', 'refs' => [ 'TreeMapFieldWells$TreeMapAggregatedFieldWells' => '

The aggregated field wells of a tree map.

', ], ], 'TreeMapConfiguration' => [ 'base' => '

The configuration of a tree map.

', 'refs' => [ 'TreeMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'TreeMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'TreeMapAggregatedFieldWells$Groups' => '

The group by field well of a tree map. Values are grouped based on group by fields.

', ], ], 'TreeMapFieldWells' => [ 'base' => '

The field wells of a tree map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TreeMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'TreeMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'TreeMapAggregatedFieldWells$Sizes' => '

The size field well of a tree map. Values are aggregated based on group by fields.

', 'TreeMapAggregatedFieldWells$Colors' => '

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

', ], ], 'TreeMapSortConfiguration' => [ 'base' => '

The sort configuration of a tree map.

', 'refs' => [ 'TreeMapConfiguration$SortConfiguration' => '

The sort configuration of a tree map.

', ], ], 'TreeMapVisual' => [ 'base' => '

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$TreeMapVisual' => '

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

', ], ], 'TrendArrowOptions' => [ 'base' => '

The options that determine the presentation of trend arrows in a KPI visual.

', 'refs' => [ 'KPIOptions$TrendArrows' => '

The options that determine the presentation of trend arrows in a KPI visual.

', ], ], 'TrinoParameters' => [ 'base' => '

The parameters that are required to connect to a Trino data source.

', 'refs' => [ 'DataSourceParameters$TrinoParameters' => '

The parameters that are required to connect to a Trino data source.

', ], ], 'TwitterParameters' => [ 'base' => '

The parameters for Twitter.

', 'refs' => [ 'DataSourceParameters$TwitterParameters' => '

The parameters for Twitter.

', ], ], 'TypeCastFormat' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$Format' => '

When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.

', ], ], 'TypeParameters' => [ 'base' => NULL, 'refs' => [ 'SemanticEntityType$TypeParameters' => '

The semantic entity type parameters.

', 'SemanticType$TypeParameters' => '

The semantic type parameters.

', ], ], 'Typography' => [ 'base' => '

Determines the typography options.

', 'refs' => [ 'ThemeConfiguration$Typography' => NULL, ], ], 'UIColorPalette' => [ 'base' => '

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'refs' => [ 'ThemeConfiguration$UIColorPalette' => '

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

', ], ], 'URLOperationTemplate' => [ 'base' => NULL, 'refs' => [ 'CustomActionURLOperation$URLTemplate' => '

THe URL link of the CustomActionURLOperation.

', 'CustomContentConfiguration$ContentUrl' => '

The input URL that links to the custom content that you want in the custom visual.

', ], ], 'URLTargetConfiguration' => [ 'base' => NULL, 'refs' => [ 'CustomActionURLOperation$URLTarget' => '

The target of the CustomActionURLOperation.

Valid values are defined as follows:

', 'TableFieldLinkConfiguration$Target' => '

The URL target (new tab, new window, same tab) for the table link configuration.

', ], ], 'UnaggregatedField' => [ 'base' => '

The unaggregated field for a table.

', 'refs' => [ 'UnaggregatedFieldList$member' => NULL, ], ], 'UnaggregatedFieldList' => [ 'base' => NULL, 'refs' => [ 'TableUnaggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

', ], ], 'UndefinedSpecifiedValueType' => [ 'base' => NULL, 'refs' => [ 'ComparativeOrder$TreatUndefinedSpecifiedValues' => '

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

', ], ], 'UnicodeIcon' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingCustomIconOptions$UnicodeIcon' => '

Determines the Unicode icon type.

', ], ], 'UniqueValuesComputation' => [ 'base' => '

The unique values computation configuration.

', 'refs' => [ 'Computation$UniqueValues' => '

The unique values computation configuration.

', ], ], 'UnlimitedPixelLength' => [ 'base' => 'String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value', 'refs' => [ 'FreeFormLayoutElement$YAxisLocation' => '

The y-axis coordinate of the element.

', ], ], 'UnsupportedPricingPlanException' => [ 'base' => '

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.

', 'refs' => [], ], 'UnsupportedUserEditionException' => [ 'base' => '

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.

', 'refs' => [], ], 'UntagColumnOperation' => [ 'base' => '

A transform operation that removes tags associated with a column.

', 'refs' => [ 'TransformOperation$UntagColumnOperation' => NULL, ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardLinksResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPublishedVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPublishedVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourcePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourcePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityPropagationConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityPropagationConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpRestrictionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpRestrictionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKeyRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKeyRegistrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkPermissionList' => [ 'base' => NULL, 'refs' => [ 'UpdateDashboardPermissionsRequest$GrantLinkPermissions' => '

Grants link permissions to all users in a defined namespace.

', 'UpdateDashboardPermissionsRequest$RevokeLinkPermissions' => '

Revokes link permissions from all users in a defined namespace.

', ], ], 'UpdatePublicSharingSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePublicSharingSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourcePermissionList' => [ 'base' => NULL, 'refs' => [ 'UpdateAnalysisPermissionsRequest$GrantPermissions' => '

A structure that describes the permissions to add and the principal to add them to.

', 'UpdateAnalysisPermissionsRequest$RevokePermissions' => '

A structure that describes the permissions to remove and the principal to remove them from.

', 'UpdateDashboardPermissionsRequest$GrantPermissions' => '

The permissions that you want to grant on this resource.

', 'UpdateDashboardPermissionsRequest$RevokePermissions' => '

The permissions that you want to revoke from this resource.

', 'UpdateTemplatePermissionsRequest$GrantPermissions' => '

A list of resource permissions to be granted on the template.

', 'UpdateTemplatePermissionsRequest$RevokePermissions' => '

A list of resource permissions to be revoked from the template.

', 'UpdateThemePermissionsRequest$GrantPermissions' => '

A list of resource permissions to be granted for the theme.

', 'UpdateThemePermissionsRequest$RevokePermissions' => '

A list of resource permissions to be revoked from the theme.

', 'UpdateTopicPermissionsRequest$GrantPermissions' => '

The resource permissions that you want to grant to the topic.

', 'UpdateTopicPermissionsRequest$RevokePermissions' => '

The resource permissions that you want to revoke from the topic.

', ], ], 'UpdateRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSPICECapacityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSPICECapacityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplatePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplatePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UploadSettings' => [ 'base' => '

Information about the format for a source file or files.

', 'refs' => [ 'S3Source$UploadSettings' => '

Information about the format for the S3 source file or files.

', ], ], 'User' => [ 'base' => '

A registered user of Amazon QuickSight.

', 'refs' => [ 'DescribeUserResponse$User' => '

The user name.

', 'RegisterUserResponse$User' => '

The user\'s user name.

', 'UpdateUserResponse$User' => '

The Amazon QuickSight user.

', 'UserList$member' => NULL, ], ], 'UserList' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$UserList' => '

The list of users.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'DeleteUserRequest$UserName' => '

The name of the user that you want to delete.

', 'DescribeUserRequest$UserName' => '

The name of the user that you want to describe.

', 'ListIAMPolicyAssignmentsForUserRequest$UserName' => '

The name of the user.

', 'ListUserGroupsRequest$UserName' => '

The Amazon QuickSight user name that you want to list group memberships for.

', 'RegisterUserRequest$UserName' => '

The Amazon QuickSight user name that you want to create for the user you are registering.

', 'UpdateUserRequest$UserName' => '

The Amazon QuickSight user name that you want to update.

', 'User$UserName' => '

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.

', ], ], 'UserRole' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$UserRole' => '

The Amazon QuickSight role for the user. The user role can be one of the following:

', 'UpdateUserRequest$Role' => '

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

', 'User$Role' => '

The Amazon QuickSight role for the user. The user role can be one of the following:.

', ], ], 'VPCConnection' => [ 'base' => '

The structure of a VPC connection.

', 'refs' => [ 'DescribeVPCConnectionResponse$VPCConnection' => '

A response object that provides information for the specified VPC connection.

', ], ], 'VPCConnectionAvailabilityStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'DeleteVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'UpdateVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'VPCConnection$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'VPCConnectionSummary$AvailabilityStatus' => '

The availability status of the VPC connection.

', ], ], 'VPCConnectionResourceIdRestricted' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'CreateVPCConnectionResponse$VPCConnectionId' => '

The ID for the VPC connection that you\'re creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', ], ], 'VPCConnectionResourceIdUnrestricted' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$VPCConnectionId' => '

The ID of the VPC Connection to apply overrides to.

', 'DeleteVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteVPCConnectionResponse$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'UpdateVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'UpdateVPCConnectionResponse$VPCConnectionId' => '

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

', 'VPCConnection$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'VPCConnectionSummary$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', ], ], 'VPCConnectionResourceStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionResponse$CreationStatus' => '

The status of the creation of the VPC connection.

', 'DeleteVPCConnectionResponse$DeletionStatus' => '

The deletion status of the VPC connection.

', 'UpdateVPCConnectionResponse$UpdateStatus' => '

The update status of the VPC connection\'s last update.

', 'VPCConnection$Status' => '

The status of the VPC connection.

', 'VPCConnectionSummary$Status' => '

The status of the VPC connection.

', ], ], 'VPCConnectionSummary' => [ 'base' => '

The summary metadata that describes a VPC connection.

', 'refs' => [ 'VPCConnectionSummaryList$member' => NULL, ], ], 'VPCConnectionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVPCConnectionsResponse$VPCConnectionSummaries' => '

A VPCConnectionSummaries object that returns a summary of VPC connection objects.

', ], ], 'ValidationStrategy' => [ 'base' => '

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

', 'refs' => [ 'CreateAnalysisRequest$ValidationStrategy' => '

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

', 'CreateDashboardRequest$ValidationStrategy' => '

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

', 'CreateTemplateRequest$ValidationStrategy' => '

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

', 'UpdateAnalysisRequest$ValidationStrategy' => '

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

', 'UpdateDashboardRequest$ValidationStrategy' => '

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

', 'UpdateTemplateRequest$ValidationStrategy' => '

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

', ], ], 'ValidationStrategyMode' => [ 'base' => NULL, 'refs' => [ 'ValidationStrategy$Mode' => '

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

', ], ], 'ValueWhenUnsetOption' => [ 'base' => NULL, 'refs' => [ 'DateTimeValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'DecimalValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'IntegerValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'StringValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', ], ], 'VersionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$VersionDescription' => '

A description for the first version of the dashboard being created.

', 'CreateTemplateRequest$VersionDescription' => '

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

', 'CreateThemeRequest$VersionDescription' => '

A description of the first version of the theme that you\'re creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

', 'DashboardVersion$Description' => '

Description.

', 'DashboardVersionSummary$Description' => '

Description.

', 'TemplateVersion$Description' => '

The description of the template.

', 'TemplateVersionSummary$Description' => '

The description of the template version.

', 'ThemeVersion$Description' => '

The description of the theme.

', 'ThemeVersionSummary$Description' => '

The description of the theme version.

', 'UpdateDashboardRequest$VersionDescription' => '

A description for the first version of the dashboard being created.

', 'UpdateTemplateRequest$VersionDescription' => '

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

', 'UpdateThemeRequest$VersionDescription' => '

A description of the theme version that you\'re updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

', ], ], 'VersionNumber' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateAliasRequest$TemplateVersionNumber' => '

The version number of the template.

', 'CreateThemeAliasRequest$ThemeVersionNumber' => '

The version number of the theme.

', 'DashboardSummary$PublishedVersionNumber' => '

Published version number.

', 'DashboardVersion$VersionNumber' => '

Version number for this version of the dashboard.

', 'DashboardVersionSummary$VersionNumber' => '

Version number.

', 'DeleteDashboardRequest$VersionNumber' => '

The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

', 'DeleteTemplateRequest$VersionNumber' => '

Specifies the version of the template that you want to delete. If you don\'t provide a version number, DeleteTemplate deletes all versions of the template.

', 'DeleteThemeRequest$VersionNumber' => '

The version of the theme that you want to delete.

Note: If you don\'t provide a version number, you\'re using this call to DeleteTheme to delete all versions of the theme.

', 'DescribeDashboardDefinitionRequest$VersionNumber' => '

The version number for the dashboard. If a version number isn\'t passed, the latest published dashboard version is described.

', 'DescribeDashboardRequest$VersionNumber' => '

The version number for the dashboard. If a version number isn\'t passed, the latest published dashboard version is described.

', 'DescribeTemplateDefinitionRequest$VersionNumber' => '

The version number of the template.

', 'DescribeTemplateRequest$VersionNumber' => '

(Optional) The number for the version to describe. If a VersionNumber parameter value isn\'t provided, the latest version of the template is described.

', 'DescribeThemeRequest$VersionNumber' => '

The version number for the version to describe. If a VersionNumber parameter value isn\'t provided, the latest version of the theme is described.

', 'TemplateAlias$TemplateVersionNumber' => '

The version number of the template alias.

', 'TemplateSummary$LatestVersionNumber' => '

A structure containing a list of version numbers for the template summary.

', 'TemplateVersion$VersionNumber' => '

The version number of the template version.

', 'TemplateVersionSummary$VersionNumber' => '

The version number of the template version.

', 'ThemeAlias$ThemeVersionNumber' => '

The version number of the theme alias.

', 'ThemeSummary$LatestVersionNumber' => '

The latest version number for the theme.

', 'ThemeVersion$VersionNumber' => '

The version number of the theme.

', 'ThemeVersionSummary$VersionNumber' => '

The version number of the theme version.

', 'UpdateDashboardPublishedVersionRequest$VersionNumber' => '

The version number of the dashboard.

', 'UpdateTemplateAliasRequest$TemplateVersionNumber' => '

The version number of the template.

', 'UpdateThemeAliasRequest$ThemeVersionNumber' => '

The version number of the theme that the alias should reference.

', ], ], 'VerticalTextAlignment' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$VerticalTextAlignment' => '

The vertical text alignment (top, middle, bottom) for the table cells.

', ], ], 'Visibility' => [ 'base' => NULL, 'refs' => [ 'AxisDisplayOptions$AxisLineVisibility' => '

Determines whether or not the axis line is visible.

', 'AxisDisplayOptions$GridLineVisibility' => '

Determines whether or not the grid line is visible.

', 'BoxPlotOptions$OutlierVisibility' => '

Determines the visibility of the outlier in a box plot.

', 'BoxPlotOptions$AllDataPointsVisibility' => '

Determines the visibility of all data points of the box plot.

', 'ChartAxisLabelOptions$Visibility' => '

The visibility of an axis label on a chart. Choose one of the following options:

', 'ChartAxisLabelOptions$SortIconVisibility' => '

The visibility configuration of the sort icon on a chart\'s axis label.

', 'ColumnTooltipItem$Visibility' => '

The visibility of the tooltip item.

', 'DataLabelOptions$Visibility' => '

Determines the visibility of the data labels.

', 'DataLabelOptions$CategoryLabelVisibility' => '

Determines the visibility of the category field labels.

', 'DataLabelOptions$MeasureLabelVisibility' => '

Determines the visibility of the measure field labels.

', 'DataLabelOptions$TotalsVisibility' => '

Determines the visibility of the total.

', 'DataPathLabelType$Visibility' => '

The visibility of the data label.

', 'DateAxisOptions$MissingDateVisibility' => '

Determines whether or not missing dates are displayed.

', 'DateTimePickerControlDisplayOptions$HelperTextVisibility' => '

The helper text visibility of the DateTimePickerControlDisplayOptions.

', 'DateTimePickerControlDisplayOptions$DateIconVisibility' => '

The date icon visibility of the DateTimePickerControlDisplayOptions.

', 'DonutCenterOptions$LabelVisibility' => '

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called \'Show total\'.

', 'FieldBasedTooltip$AggregationVisibility' => '

The visibility of Show aggregations.

', 'FieldLabelType$Visibility' => '

The visibility of the field label.

', 'FieldTooltipItem$Visibility' => '

The visibility of the tooltip item.

', 'FreeFormLayoutElement$Visibility' => '

The visibility of an element within a free-form layout.

', 'FreeFormLayoutElementBackgroundStyle$Visibility' => '

The background visibility of a free-form layout element.

', 'FreeFormLayoutElementBorderStyle$Visibility' => '

The border visibility of a free-form layout element.

', 'FunnelChartDataLabelOptions$Visibility' => '

The visibility option that determines if data labels are displayed.

', 'FunnelChartDataLabelOptions$CategoryLabelVisibility' => '

The visibility of the category labels within the data labels.

', 'FunnelChartDataLabelOptions$MeasureLabelVisibility' => '

The visibility of the measure labels within the data labels.

', 'KPISparklineOptions$Visibility' => '

The visibility of the sparkline.

', 'KPISparklineOptions$TooltipVisibility' => '

The tooltip visibility of the sparkline.

', 'LabelOptions$Visibility' => '

Determines whether or not the label is visible.

', 'LegendOptions$Visibility' => '

Determines whether or not the legend is visible.

', 'LineChartLineStyleSettings$LineVisibility' => '

Configuration option that determines whether to show the line for the series.

', 'LineChartMarkerStyleSettings$MarkerVisibility' => '

Configuration option that determines whether to show the markers in the series.

', 'ListControlSearchOptions$Visibility' => '

The visibility configuration of the search options in a list control.

', 'ListControlSelectAllOptions$Visibility' => '

The visibility configuration of the Select all options in a list control.

', 'LoadingAnimation$Visibility' => '

The visibility configuration of LoadingAnimation.

', 'MaximumLabelType$Visibility' => '

The visibility of the maximum label.

', 'MinimumLabelType$Visibility' => '

The visibility of the minimum label.

', 'PanelConfiguration$BorderVisibility' => '

Determines whether or not each panel displays a border.

', 'PanelConfiguration$GutterVisibility' => '

Determines whether or not negative space between sibling panels is rendered.

', 'PanelConfiguration$BackgroundVisibility' => '

Determines whether or not a background for each small multiples panel is rendered.

', 'PanelTitleOptions$Visibility' => '

Determines whether or not panel titles are displayed.

', 'PivotTableFieldOption$Visibility' => '

The visibility of the pivot table field.

', 'PivotTableOptions$SingleMetricVisibility' => '

The visibility of the single metric options.

', 'PivotTableOptions$ColumnNamesVisibility' => '

The visibility of the column names.

', 'PivotTableOptions$ToggleButtonsVisibility' => '

Determines the visibility of the pivot table.

', 'PivotTableOptions$CollapsedRowDimensionsVisibility' => '

The visibility setting of a pivot table\'s collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

', 'PivotTablePaginatedReportOptions$VerticalOverflowVisibility' => '

The visibility of the printing table overflow across pages.

', 'PivotTablePaginatedReportOptions$OverflowColumnHeaderVisibility' => '

The visibility of the repeating header rows on each page.

', 'PivotTableRowsLabelOptions$Visibility' => '

The visibility of the rows label.

', 'PivotTotalOptions$TotalsVisibility' => '

The visibility configuration for the total cells.

', 'ProgressBarOptions$Visibility' => '

The visibility of the progress bar.

', 'RadarChartAreaStyleSettings$Visibility' => '

The visibility settings of a radar chart.

', 'RadarChartConfiguration$AlternateBandColorsVisibility' => '

Determines the visibility of the colors of alternatign bands in a radar chart.

', 'RangeEndsLabelType$Visibility' => '

The visibility of the range ends label.

', 'ScrollBarOptions$Visibility' => '

The visibility of the data zoom scroll bar.

', 'SecondaryValueOptions$Visibility' => '

Determines the visibility of the secondary value.

', 'SheetControlInfoIconLabelOptions$Visibility' => '

The visibility configuration of info icon label options.

', 'SheetElementConfigurationOverrides$Visibility' => '

Determines whether or not the overrides are visible. Choose one of the following options:

', 'SubtotalOptions$TotalsVisibility' => '

The visibility configuration for the subtotal cells.

', 'TableCellStyle$Visibility' => '

The visibility of the table cells.

', 'TableFieldOption$Visibility' => '

The visibility of a table field.

', 'TablePaginatedReportOptions$VerticalOverflowVisibility' => '

The visibility of printing table overflow across pages.

', 'TablePaginatedReportOptions$OverflowColumnHeaderVisibility' => '

The visibility of repeating header rows on each page.

', 'TextControlPlaceholderOptions$Visibility' => '

The visibility configuration of the placeholder options in a text control.

', 'ThousandSeparatorOptions$Visibility' => '

Determines the visibility of the thousands separator.

', 'TooltipOptions$TooltipVisibility' => '

Determines whether or not the tooltip is visible.

', 'TotalOptions$TotalsVisibility' => '

The visibility configuration for the total cells.

', 'TrendArrowOptions$Visibility' => '

The visibility of the trend arrows.

', 'VisualSubtitleLabelOptions$Visibility' => '

The visibility of the subtitle label.

', 'VisualTitleLabelOptions$Visibility' => '

The visibility of the title label.

', ], ], 'VisiblePanelColumns' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesOptions$MaxVisibleColumns' => '

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

', ], ], 'VisiblePanelRows' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesOptions$MaxVisibleRows' => '

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

', ], ], 'VisibleRangeOptions' => [ 'base' => '

The range options for the data zoom scroll bar.

', 'refs' => [ 'ScrollBarOptions$VisibleRange' => '

The visibility range for the data zoom scroll bar.

', ], ], 'Visual' => [ 'base' => '

A visual displayed on a sheet in an analysis, dashboard, or template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualList$member' => NULL, ], ], 'VisualAxisSortOption' => [ 'base' => '

The axis sort options for a visual.

', 'refs' => [ 'DashboardPublishOptions$VisualAxisSortOption' => '

The axis sort options of a dashboard.

', ], ], 'VisualCustomAction' => [ 'base' => '

A custom action defined on a visual.

', 'refs' => [ 'VisualCustomActionList$member' => NULL, ], ], 'VisualCustomActionList' => [ 'base' => NULL, 'refs' => [ 'BarChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'BoxPlotVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'ComboChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'CustomContentVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'EmptyVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'FilledMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'FunnelChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'GaugeChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'GeospatialMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'HeatMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'HistogramVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'InsightVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'KPIVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'LineChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'PieChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'PivotTableVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'RadarChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'SankeyDiagramVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'ScatterPlotVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'TableVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'TreeMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'WaterfallVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'WordCloudVisual$Actions' => '

The list of custom actions that are configured for a visual.

', ], ], 'VisualCustomActionName' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$Name' => '

The name of the VisualCustomAction.

', ], ], 'VisualCustomActionOperation' => [ 'base' => '

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualCustomActionOperationList$member' => NULL, ], ], 'VisualCustomActionOperationList' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$ActionOperations' => '

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', ], ], 'VisualCustomActionTrigger' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$Trigger' => '

The trigger of the VisualCustomAction.

Valid values are defined as follows:

', ], ], 'VisualInteractionOptions' => [ 'base' => '

The general visual interactions setup for visual publish options

', 'refs' => [ 'BarChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'BoxPlotChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'ComboChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'CustomContentConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'FilledMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'FunnelChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'GaugeChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'GeospatialMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'HeatMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'HistogramConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'InsightConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'KPIConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'LineChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'PieChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'PivotTableConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'RadarChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'SankeyDiagramChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'ScatterPlotConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'TableConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'TreeMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'WaterfallChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'WordCloudChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', ], ], 'VisualList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Visuals' => '

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

', ], ], 'VisualMenuOption' => [ 'base' => '

The menu options for a visual.

', 'refs' => [ 'DashboardPublishOptions$VisualMenuOption' => '

The menu options of a visual in a dashboard.

', 'VisualInteractionOptions$VisualMenuOption' => '

The on-visual menu options for a visual.

', ], ], 'VisualOptions' => [ 'base' => '

The definition for a VisualOptions.

', 'refs' => [ 'TopicIR$Visual' => '

The visual for the TopicIR.

', ], ], 'VisualPalette' => [ 'base' => '

The visual display options for the visual palette.

', 'refs' => [ 'BarChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'BoxPlotChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'ComboChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'FunnelChartConfiguration$VisualPalette' => '

The visual palette configuration of a FunnelChartVisual.

', 'GaugeChartConfiguration$VisualPalette' => '

The visual palette configuration of a GaugeChartVisual.

', 'GeospatialMapConfiguration$VisualPalette' => NULL, 'HistogramConfiguration$VisualPalette' => '

The visual palette configuration of a histogram.

', 'LineChartConfiguration$VisualPalette' => '

The visual palette configuration of a line chart.

', 'PieChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'RadarChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'ScatterPlotConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'WaterfallChartConfiguration$VisualPalette' => '

The visual palette configuration of a waterfall visual.

', ], ], 'VisualRole' => [ 'base' => NULL, 'refs' => [ 'TopicVisual$Role' => '

The role for the TopicVisual.

', ], ], 'VisualSubtitleLabelOptions' => [ 'base' => '

The subtitle label options for a visual.

', 'refs' => [ 'BarChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'BoxPlotVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'ComboChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'CustomContentVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'FilledMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'FunnelChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'GaugeChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'GeospatialMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'HeatMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'HistogramVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'InsightVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'KPIVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'LineChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'PieChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'PivotTableVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'RadarChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'SankeyDiagramVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'ScatterPlotVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'TableVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'TreeMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'WaterfallVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'WordCloudVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', ], ], 'VisualTitleLabelOptions' => [ 'base' => '

The title label options for a visual.

', 'refs' => [ 'BarChartVisual$Title' => '

The title that is displayed on the visual.

', 'BoxPlotVisual$Title' => '

The title that is displayed on the visual.

', 'ComboChartVisual$Title' => '

The title that is displayed on the visual.

', 'CustomContentVisual$Title' => '

The title that is displayed on the visual.

', 'FilledMapVisual$Title' => '

The title that is displayed on the visual.

', 'FunnelChartVisual$Title' => '

The title that is displayed on the visual.

', 'GaugeChartVisual$Title' => '

The title that is displayed on the visual.

', 'GeospatialMapVisual$Title' => '

The title that is displayed on the visual.

', 'HeatMapVisual$Title' => '

The title that is displayed on the visual.

', 'HistogramVisual$Title' => '

The title that is displayed on the visual.

', 'InsightVisual$Title' => '

The title that is displayed on the visual.

', 'KPIVisual$Title' => '

The title that is displayed on the visual.

', 'LineChartVisual$Title' => '

The title that is displayed on the visual.

', 'PieChartVisual$Title' => '

The title that is displayed on the visual.

', 'PivotTableVisual$Title' => '

The title that is displayed on the visual.

', 'RadarChartVisual$Title' => '

The title that is displayed on the visual.

', 'SankeyDiagramVisual$Title' => '

The title that is displayed on the visual.

', 'ScatterPlotVisual$Title' => '

The title that is displayed on the visual.

', 'TableVisual$Title' => '

The title that is displayed on the visual.

', 'TreeMapVisual$Title' => '

The title that is displayed on the visual.

', 'WaterfallVisual$Title' => '

The title that is displayed on the visual.

', 'WordCloudVisual$Title' => '

The title that is displayed on the visual.

', ], ], 'VpcConnectionProperties' => [ 'base' => '

VPC connection properties.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$VpcConnectionProperties' => NULL, 'CreateDataSourceRequest$VpcConnectionProperties' => '

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

', 'DataSource$VpcConnectionProperties' => '

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.

', 'UpdateDataSourceRequest$VpcConnectionProperties' => '

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointIdRestrictionRuleMap$key' => NULL, ], ], 'VpcEndpointIdRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointIdRestrictionRuleMap$value' => NULL, ], ], 'VpcEndpointIdRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$VpcEndpointIdRestrictionRuleMap' => '

A map of allowed VPC endpoint IDs and their rule descriptions.

', 'UpdateIpRestrictionRequest$VpcEndpointIdRestrictionRuleMap' => '

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcIdRestrictionRuleMap$key' => NULL, ], ], 'VpcIdRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'VpcIdRestrictionRuleMap$value' => NULL, ], ], 'VpcIdRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$VpcIdRestrictionRuleMap' => '

A map of allowed VPC IDs and their rule descriptions.

', 'UpdateIpRestrictionRequest$VpcIdRestrictionRuleMap' => '

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

', ], ], 'Warehouse' => [ 'base' => NULL, 'refs' => [ 'SnowflakeParameters$Warehouse' => '

Warehouse.

', ], ], 'WaterfallChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartFieldWells$WaterfallChartAggregatedFieldWells' => '

The field well configuration of a waterfall visual.

', ], ], 'WaterfallChartColorConfiguration' => [ 'base' => '

The color configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$ColorConfiguration' => '

The color configuration of a waterfall visual.

', ], ], 'WaterfallChartConfiguration' => [ 'base' => '

The configuration for a waterfall visual.

', 'refs' => [ 'WaterfallVisual$ChartConfiguration' => '

The configuration for a waterfall visual.

', ], ], 'WaterfallChartFieldWells' => [ 'base' => '

The field well configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$FieldWells' => '

The field well configuration of a waterfall visual.

', ], ], 'WaterfallChartGroupColorConfiguration' => [ 'base' => '

The color configuration for individual groups within a waterfall visual.

', 'refs' => [ 'WaterfallChartColorConfiguration$GroupColorConfiguration' => '

The color configuration for individual groups within a waterfall visual.

', ], ], 'WaterfallChartOptions' => [ 'base' => '

The options that determine the presentation of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$WaterfallChartOptions' => '

The options that determine the presentation of a waterfall visual.

', ], ], 'WaterfallChartSortConfiguration' => [ 'base' => '

The sort configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$SortConfiguration' => '

The sort configuration of a waterfall visual.

', ], ], 'WaterfallVisual' => [ 'base' => '

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$WaterfallVisual' => '

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

', ], ], 'WhatIfPointScenario' => [ 'base' => '

Provides the forecast to meet the target for a particular date.

', 'refs' => [ 'ForecastScenario$WhatIfPointScenario' => '

The what-if analysis forecast setup with the target date.

', ], ], 'WhatIfRangeScenario' => [ 'base' => '

Provides the forecast to meet the target for a particular date range.

', 'refs' => [ 'ForecastScenario$WhatIfRangeScenario' => '

The what-if analysis forecast setup with the date range.

', ], ], 'WidgetStatus' => [ 'base' => NULL, 'refs' => [ 'ExcludePeriodConfiguration$Status' => '

The status of the exclude period. Choose from the following options:

', 'FilterGroup$Status' => '

The status of the FilterGroup.

', 'ReferenceLine$Status' => '

The status of the reference line. Choose one of the following options:

', 'RowAlternateColorOptions$Status' => '

Determines the widget status.

', 'RowAlternateColorOptions$UsePrimaryBackgroundColor' => '

The primary background color options for alternate rows.

', 'VisualCustomAction$Status' => '

The status of the VisualCustomAction.

', ], ], 'WordCloudAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a word cloud.

', 'refs' => [ 'WordCloudFieldWells$WordCloudAggregatedFieldWells' => '

The aggregated field wells of a word cloud.

', ], ], 'WordCloudChartConfiguration' => [ 'base' => '

The configuration of a word cloud visual.

', 'refs' => [ 'WordCloudVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'WordCloudCloudLayout' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$CloudLayout' => '

The cloud layout options (fluid, normal) of a word cloud.

', ], ], 'WordCloudDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'WordCloudAggregatedFieldWells$GroupBy' => '

The group by field well of a word cloud. Values are grouped by group by fields.

', ], ], 'WordCloudFieldWells' => [ 'base' => '

The field wells of a word cloud visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'WordCloudChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'WordCloudMaximumStringLength' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$MaximumStringLength' => '

The length limit of each word from 1-100.

', ], ], 'WordCloudMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'WordCloudAggregatedFieldWells$Size' => '

The size field well of a word cloud. Values are aggregated based on group by fields.

', ], ], 'WordCloudOptions' => [ 'base' => '

The word cloud options for a word cloud visual.

', 'refs' => [ 'WordCloudChartConfiguration$WordCloudOptions' => '

The options for a word cloud visual.

', ], ], 'WordCloudSortConfiguration' => [ 'base' => '

The sort configuration of a word cloud visual.

', 'refs' => [ 'WordCloudChartConfiguration$SortConfiguration' => '

The sort configuration of a word cloud visual.

', ], ], 'WordCloudVisual' => [ 'base' => '

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$WordCloudVisual' => '

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

', ], ], 'WordCloudWordCasing' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordCasing' => '

The word casing options (lower_case, existing_case) for the words in a word cloud.

', ], ], 'WordCloudWordOrientation' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordOrientation' => '

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

', ], ], 'WordCloudWordPadding' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordPadding' => '

The word padding options (none, small, medium, large) for the words in a word cloud.

', ], ], 'WordCloudWordScaling' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordScaling' => '

The word scaling options (emphasize, normal) for the words in a word cloud.

', ], ], 'WorkGroup' => [ 'base' => NULL, 'refs' => [ 'AthenaParameters$WorkGroup' => '

The workgroup that Amazon Athena uses.

', ], ], 'YAxisOptions' => [ 'base' => '

The options that are available for a single Y axis in a chart.

', 'refs' => [ 'SingleAxisOptions$YAxisOptions' => '

The Y axis options of a single axis configuration.

', ], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountCustomizationRequest$Resolved' => '

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.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

', 'operations' => [ 'BatchCreateTopicReviewedAnswer' => '

Creates new reviewed answers for a Q Topic.

', 'BatchDeleteTopicReviewedAnswer' => '

Deletes reviewed answers for Q Topic.

', 'CancelIngestion' => '

Cancels an ongoing ingestion of data into SPICE.

', 'CreateAccountCustomization' => '

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.

', 'CreateAccountSubscription' => '

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.

', 'CreateAnalysis' => '

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

', 'CreateDashboard' => '

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.

', 'CreateDataSet' => '

Creates a dataset. This operation doesn\'t support datasets that include uploaded files as a source.

', 'CreateDataSource' => '

Creates a data source.

', 'CreateFolder' => '

Creates an empty shared folder.

', 'CreateFolderMembership' => '

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

', 'CreateGroup' => '

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.

', 'CreateGroupMembership' => '

Adds an Amazon QuickSight user to an Amazon QuickSight group.

', 'CreateIAMPolicyAssignment' => '

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

', 'CreateIngestion' => '

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

', 'CreateNamespace' => '

(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 Services Support.

', 'CreateRefreshSchedule' => '

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

', 'CreateRoleMembership' => '

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

', 'CreateTemplate' => '

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.

', 'CreateTemplateAlias' => '

Creates a template alias for a template.

', 'CreateTheme' => '

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'CreateThemeAlias' => '

Creates a theme alias for a theme.

', 'CreateTopic' => '

Creates a new Q topic.

', 'CreateTopicRefreshSchedule' => '

Creates a topic refresh schedule.

', 'CreateVPCConnection' => '

Creates a new VPC connection.

', 'DeleteAccountCustomization' => '

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

', 'DeleteAccountSubscription' => '

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.

', 'DeleteAnalysis' => '

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.

', 'DeleteDashboard' => '

Deletes a dashboard.

', 'DeleteDataSet' => '

Deletes a dataset.

', 'DeleteDataSetRefreshProperties' => '

Deletes the dataset refresh properties of the dataset.

', 'DeleteDataSource' => '

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

', 'DeleteFolder' => '

Deletes an empty folder.

', 'DeleteFolderMembership' => '

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

', 'DeleteGroup' => '

Removes a user group from Amazon QuickSight.

', 'DeleteGroupMembership' => '

Removes a user from a group so that the user is no longer a member of the group.

', 'DeleteIAMPolicyAssignment' => '

Deletes an existing IAM policy assignment.

', 'DeleteIdentityPropagationConfig' => '

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.

', 'DeleteNamespace' => '

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

', 'DeleteRefreshSchedule' => '

Deletes a refresh schedule from a dataset.

', 'DeleteRoleCustomPermission' => '

Removes custom permissions from the role.

', 'DeleteRoleMembership' => '

Removes a group from a role.

', 'DeleteTemplate' => '

Deletes a template.

', 'DeleteTemplateAlias' => '

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

', 'DeleteTheme' => '

Deletes a theme.

', 'DeleteThemeAlias' => '

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

', 'DeleteTopic' => '

Deletes a topic.

', 'DeleteTopicRefreshSchedule' => '

Deletes a topic refresh schedule.

', 'DeleteUser' => '

Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that\'s making the call. The IAM user isn\'t deleted as a result of this call.

', 'DeleteUserByPrincipalId' => '

Deletes a user identified by its principal ID.

', 'DeleteVPCConnection' => '

Deletes a VPC connection.

', 'DescribeAccountCustomization' => '

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.

', 'DescribeAccountSettings' => '

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

', 'DescribeAccountSubscription' => '

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.

', 'DescribeAnalysis' => '

Provides a summary of the metadata for an analysis.

', 'DescribeAnalysisDefinition' => '

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

', 'DescribeAnalysisPermissions' => '

Provides the read and write permissions for an analysis.

', 'DescribeAssetBundleExportJob' => '

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets\' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

', 'DescribeAssetBundleImportJob' => '

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

', 'DescribeDashboard' => '

Provides a summary for a dashboard.

', 'DescribeDashboardDefinition' => '

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

', 'DescribeDashboardPermissions' => '

Describes read and write permissions for a dashboard.

', 'DescribeDashboardSnapshotJob' => '

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

', 'DescribeDashboardSnapshotJobResult' => '

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..

', 'DescribeDataSet' => '

Describes a dataset. This operation doesn\'t support datasets that include uploaded files as a source.

', 'DescribeDataSetPermissions' => '

Describes the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

', 'DescribeDataSetRefreshProperties' => '

Describes the refresh properties of a dataset.

', 'DescribeDataSource' => '

Describes a data source.

', 'DescribeDataSourcePermissions' => '

Describes the resource permissions for a data source.

', 'DescribeFolder' => '

Describes a folder.

', 'DescribeFolderPermissions' => '

Describes permissions for a folder.

', 'DescribeFolderResolvedPermissions' => '

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

', 'DescribeGroup' => '

Returns an Amazon QuickSight group\'s description and Amazon Resource Name (ARN).

', 'DescribeGroupMembership' => '

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

', 'DescribeIAMPolicyAssignment' => '

Describes an existing IAM policy assignment, as specified by the assignment name.

', 'DescribeIngestion' => '

Describes a SPICE ingestion.

', 'DescribeIpRestriction' => '

Provides a summary and status of IP rules.

', 'DescribeKeyRegistration' => '

Describes all customer managed key registrations in a Amazon QuickSight account.

', 'DescribeNamespace' => '

Describes the current namespace.

', 'DescribeRefreshSchedule' => '

Provides a summary of a refresh schedule.

', 'DescribeRoleCustomPermission' => '

Describes all custom permissions that are mapped to a role.

', 'DescribeTemplate' => '

Describes a template\'s metadata.

', 'DescribeTemplateAlias' => '

Describes the template alias for a template.

', 'DescribeTemplateDefinition' => '

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

', 'DescribeTemplatePermissions' => '

Describes read and write permissions on a template.

', 'DescribeTheme' => '

Describes a theme.

', 'DescribeThemeAlias' => '

Describes the alias for a theme.

', 'DescribeThemePermissions' => '

Describes the read and write permissions for a theme.

', 'DescribeTopic' => '

Describes a topic.

', 'DescribeTopicPermissions' => '

Describes the permissions of a topic.

', 'DescribeTopicRefresh' => '

Describes the status of a topic refresh.

', 'DescribeTopicRefreshSchedule' => '

Deletes a topic refresh schedule.

', 'DescribeUser' => '

Returns information about a user, given the user name.

', 'DescribeVPCConnection' => '

Describes a VPC connection.

', 'GenerateEmbedUrlForAnonymousUser' => '

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

For more information, see Embedded Analytics 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.

', 'GenerateEmbedUrlForRegisteredUser' => '

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 registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

For more information, see Embedded Analytics 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.

', 'GetDashboardEmbedUrl' => '

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:

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' => '

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:

', 'ListAnalyses' => '

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

', 'ListAssetBundleExportJobs' => '

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

', 'ListAssetBundleImportJobs' => '

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

', 'ListDashboardVersions' => '

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

', 'ListDashboards' => '

Lists dashboards in an Amazon Web Services account.

', 'ListDataSets' => '

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

', 'ListDataSources' => '

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

', 'ListFolderMembers' => '

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

', 'ListFolders' => '

Lists all folders in an account.

', 'ListGroupMemberships' => '

Lists member users in a group.

', 'ListGroups' => '

Lists all user groups in Amazon QuickSight.

', 'ListIAMPolicyAssignments' => '

Lists the IAM policy assignments in the current Amazon QuickSight account.

', 'ListIAMPolicyAssignmentsForUser' => '

Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.

', 'ListIdentityPropagationConfigs' => '

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.

', 'ListIngestions' => '

Lists the history of SPICE ingestions for a dataset.

', 'ListNamespaces' => '

Lists the namespaces for the specified Amazon Web Services account. This operation doesn\'t list deleted namespaces.

', 'ListRefreshSchedules' => '

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

', 'ListRoleMemberships' => '

Lists all groups that are associated with a role.

', 'ListTagsForResource' => '

Lists the tags assigned to a resource.

', 'ListTemplateAliases' => '

Lists all the aliases of a template.

', 'ListTemplateVersions' => '

Lists all the versions of the templates in the current Amazon QuickSight account.

', 'ListTemplates' => '

Lists all the templates in the current Amazon QuickSight account.

', 'ListThemeAliases' => '

Lists all the aliases of a theme.

', 'ListThemeVersions' => '

Lists all the versions of the themes in the current Amazon Web Services account.

', 'ListThemes' => '

Lists all the themes in the current Amazon Web Services account.

', 'ListTopicRefreshSchedules' => '

Lists all of the refresh schedules for a topic.

', 'ListTopicReviewedAnswers' => '

Lists all reviewed answers for a Q Topic.

', 'ListTopics' => '

Lists all of the topics within an account.

', 'ListUserGroups' => '

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

', 'ListUsers' => '

Returns a list of all of the Amazon QuickSight users belonging to this account.

', 'ListVPCConnections' => '

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

', 'PutDataSetRefreshProperties' => '

Creates or updates the dataset refresh properties for the dataset.

', 'RegisterUser' => '

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.

', 'RestoreAnalysis' => '

Restores an analysis.

', 'SearchAnalyses' => '

Searches for analyses that belong to the user specified in the filter.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'SearchDashboards' => '

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'SearchDataSets' => '

Use the SearchDataSets operation to search for datasets that belong to an account.

', 'SearchDataSources' => '

Use the SearchDataSources operation to search for data sources that belong to an account.

', 'SearchFolders' => '

Searches the subfolders in a folder.

', 'SearchGroups' => '

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

', 'StartAssetBundleExportJob' => '

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.

', 'StartAssetBundleImportJob' => '

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.

', 'StartDashboardSnapshotJob' => '

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.

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.

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:

', 'TagResource' => '

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:

', 'UntagResource' => '

Removes a tag or tags from a resource.

', 'UpdateAccountCustomization' => '

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.

', 'UpdateAccountSettings' => '

Updates the Amazon QuickSight settings in your Amazon Web Services account.

', 'UpdateAnalysis' => '

Updates an analysis in Amazon QuickSight

', 'UpdateAnalysisPermissions' => '

Updates the read and write permissions for an analysis.

', 'UpdateDashboard' => '

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

', 'UpdateDashboardLinks' => '

Updates the linked analyses on a dashboard.

', 'UpdateDashboardPermissions' => '

Updates read and write permissions on a dashboard.

', 'UpdateDashboardPublishedVersion' => '

Updates the published version of a dashboard.

', 'UpdateDataSet' => '

Updates a dataset. This operation doesn\'t support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

', 'UpdateDataSetPermissions' => '

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

', 'UpdateDataSource' => '

Updates a data source.

', 'UpdateDataSourcePermissions' => '

Updates the permissions to a data source.

', 'UpdateFolder' => '

Updates the name of a folder.

', 'UpdateFolderPermissions' => '

Updates permissions of a folder.

', 'UpdateGroup' => '

Changes a group description.

', 'UpdateIAMPolicyAssignment' => '

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

', 'UpdateIdentityPropagationConfig' => '

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

', 'UpdateIpRestriction' => '

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

', 'UpdateKeyRegistration' => '

Updates a customer managed key in a Amazon QuickSight account.

', 'UpdatePublicSharingSettings' => '

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.

', 'UpdateRefreshSchedule' => '

Updates a refresh schedule for a dataset.

', 'UpdateRoleCustomPermission' => '

Updates the custom permissions that are associated with a role.

', 'UpdateSPICECapacityConfiguration' => '

Updates the SPICE capacity configuration for a Amazon QuickSight account.

', 'UpdateTemplate' => '

Updates a template from an existing Amazon QuickSight analysis or another template.

', 'UpdateTemplateAlias' => '

Updates the template alias of a template.

', 'UpdateTemplatePermissions' => '

Updates the resource permissions for a template.

', 'UpdateTheme' => '

Updates a theme.

', 'UpdateThemeAlias' => '

Updates an alias of a theme.

', 'UpdateThemePermissions' => '

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

', 'UpdateTopic' => '

Updates a topic.

', 'UpdateTopicPermissions' => '

Updates the permissions of a topic.

', 'UpdateTopicRefreshSchedule' => '

Updates a topic refresh schedule.

', 'UpdateUser' => '

Updates an Amazon QuickSight user.

', 'UpdateVPCConnection' => '

Updates a VPC connection.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You don\'t have access to this item. The provided credentials couldn\'t be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

', 'refs' => [], ], 'AccountCustomization' => [ 'base' => '

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

', 'refs' => [ 'CreateAccountCustomizationRequest$AccountCustomization' => '

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" }.

', 'CreateAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations you\'re adding in the current Amazon Web Services Region.

', 'DescribeAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

', 'UpdateAccountCustomizationRequest$AccountCustomization' => '

The Amazon QuickSight customizations you\'re updating in the current Amazon Web Services Region.

', 'UpdateAccountCustomizationResponse$AccountCustomization' => '

The Amazon QuickSight customizations you\'re updating in the current Amazon Web Services Region.

', ], ], 'AccountInfo' => [ 'base' => '

A structure that contains the following account information elements:

', 'refs' => [ 'DescribeAccountSubscriptionResponse$AccountInfo' => '

A structure that contains the following elements:

', ], ], 'AccountName' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AccountName' => '

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.

', ], ], 'AccountSettings' => [ 'base' => '

The Amazon QuickSight settings associated with your Amazon Web Services account.

', 'refs' => [ 'DescribeAccountSettingsResponse$AccountSettings' => '

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.

', ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleResourcePermissions$Actions' => '

A list of IAM actions to grant permissions on.

', 'ResourcePermission$Actions' => '

The IAM action to grant or revoke permissions on.

', ], ], 'ActiveIAMPolicyAssignment' => [ 'base' => '

The active Identity and Access Management (IAM) policy assignment.

', 'refs' => [ 'ActiveIAMPolicyAssignmentList$member' => NULL, ], ], 'ActiveIAMPolicyAssignmentList' => [ 'base' => NULL, 'refs' => [ 'ListIAMPolicyAssignmentsForUserResponse$ActiveAssignments' => '

The active assignments for this user.

', ], ], 'AdHocFilteringOption' => [ 'base' => '

An ad hoc (one-time) filtering option.

', 'refs' => [ 'DashboardPublishOptions$AdHocFilteringOption' => '

Ad hoc (one-time) filtering option.

', ], ], 'AdditionalDashboardIdList' => [ 'base' => NULL, 'refs' => [ 'GetDashboardEmbedUrlRequest$AdditionalDashboardIds' => '

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.

', ], ], 'AggFunction' => [ 'base' => '

The definition of an Agg function.

', 'refs' => [ 'TopicIRMetric$Function' => '

The function for the TopicIRMetric.

', ], ], 'AggFunctionParamKey' => [ 'base' => NULL, 'refs' => [ 'AggFunctionParamMap$key' => NULL, ], ], 'AggFunctionParamMap' => [ 'base' => NULL, 'refs' => [ 'AggFunction$AggregationFunctionParameters' => '

The aggregation parameters for an Agg function.

', 'TopicIRFilterOption$AggregationFunctionParameters' => '

The aggregation function parameters for the TopicIRFilterOption.

', ], ], 'AggFunctionParamValue' => [ 'base' => NULL, 'refs' => [ 'AggFunctionParamMap$value' => NULL, ], ], 'AggType' => [ 'base' => NULL, 'refs' => [ 'AggFunction$Aggregation' => '

The aggregation of an Agg function.

', 'FilterAggMetrics$Function' => '

The function for the FilterAggMetrics.

', 'TopicIRFilterOption$Aggregation' => '

The aggregation for the TopicIRFilterOption.

', ], ], 'AggregationFunction' => [ 'base' => '

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AggregationSortConfiguration$AggregationFunction' => '

The function that aggregates the values in Column.

', 'ColumnSort$AggregationFunction' => '

The aggregation function that is defined in the column sort.

', 'ColumnTooltipItem$Aggregation' => '

The aggregation function of the column tooltip item.

', 'NumericEqualityFilter$AggregationFunction' => '

The aggregation function of the filter.

', 'NumericRangeFilter$AggregationFunction' => '

The aggregation function of the filter.

', 'ReferenceLineDynamicDataConfiguration$MeasureAggregationFunction' => '

The aggregation function that is used in the dynamic data.

', ], ], 'AggregationFunctionParameters' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinitionMetric$AggregationFunctionParameters' => '

The additional parameters for an aggregation function.

', ], ], 'AggregationPartitionBy' => [ 'base' => '

The definition of an AggregationPartitionBy.

', 'refs' => [ 'AggregationPartitionByList$member' => NULL, ], ], 'AggregationPartitionByList' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$AggregationPartitionBy' => '

The AggregationPartitionBy for the TopicIRFilterOption.

', ], ], 'AggregationSortConfiguration' => [ 'base' => '

The configuration options to sort aggregated values.

', 'refs' => [ 'AggregationSortConfigurationList$member' => NULL, ], ], 'AggregationSortConfigurationList' => [ 'base' => NULL, 'refs' => [ 'TopBottomFilter$AggregationSortConfigurations' => '

The aggregation and sort configuration of the top bottom filter.

', ], ], 'AliasName' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateAliasRequest$AliasName' => '

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.

', 'CreateThemeAliasRequest$AliasName' => '

The name that you want to give to the theme alias that you are creating. The alias name can\'t begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.

', 'DeleteTemplateAliasRequest$AliasName' => '

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

', 'DeleteTemplateAliasResponse$AliasName' => '

The name for the template alias.

', 'DeleteThemeAliasRequest$AliasName' => '

The unique name for the theme alias to delete.

', 'DeleteThemeAliasResponse$AliasName' => '

The name for the theme alias.

', 'DescribeDashboardDefinitionRequest$AliasName' => '

The alias name.

', 'DescribeDashboardRequest$AliasName' => '

The alias name.

', 'DescribeTemplateAliasRequest$AliasName' => '

The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeTemplateDefinitionRequest$AliasName' => '

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeTemplateRequest$AliasName' => '

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'DescribeThemeAliasRequest$AliasName' => '

The name of the theme alias that you want to describe.

', 'DescribeThemeRequest$AliasName' => '

The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to themes.

', 'TemplateAlias$AliasName' => '

The display name of the template alias.

', 'ThemeAlias$AliasName' => '

The display name of the theme alias.

', 'UpdateTemplateAliasRequest$AliasName' => '

The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn\'t apply to templates.

', 'UpdateThemeAliasRequest$AliasName' => '

The name of the theme alias that you want to update.

', ], ], 'AllSheetsFilterScopeConfiguration' => [ 'base' => '

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterScopeConfiguration$AllSheets' => '

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

', ], ], 'AmazonElasticsearchParameters' => [ 'base' => '

The parameters for OpenSearch.

', 'refs' => [ 'DataSourceParameters$AmazonElasticsearchParameters' => '

The parameters for OpenSearch.

', ], ], 'AmazonOpenSearchParameters' => [ 'base' => '

The parameters for OpenSearch.

', 'refs' => [ 'DataSourceParameters$AmazonOpenSearchParameters' => '

The parameters for OpenSearch.

', ], ], 'Analysis' => [ 'base' => '

Metadata structure for an analysis in Amazon QuickSight

', 'refs' => [ 'DescribeAnalysisResponse$Analysis' => '

A metadata structure that contains summary information for the analysis that you\'re describing.

', ], ], 'AnalysisDefaults' => [ 'base' => '

The configuration for default analysis settings.

', 'refs' => [ 'AnalysisDefinition$AnalysisDefaults' => NULL, 'DashboardVersionDefinition$AnalysisDefaults' => NULL, 'TemplateVersionDefinition$AnalysisDefaults' => NULL, ], ], 'AnalysisDefinition' => [ 'base' => '

The definition of an analysis.

', 'refs' => [ 'CreateAnalysisRequest$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeAnalysisDefinitionResponse$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateAnalysisRequest$Definition' => '

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'AnalysisError' => [ 'base' => '

Analysis error.

', 'refs' => [ 'AnalysisErrorList$member' => NULL, ], ], 'AnalysisErrorList' => [ 'base' => NULL, 'refs' => [ 'Analysis$Errors' => '

Errors associated with the analysis.

', 'DescribeAnalysisDefinitionResponse$Errors' => '

Errors associated with the analysis.

', ], ], 'AnalysisErrorType' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$Type' => '

The type of the analysis error.

', ], ], 'AnalysisFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'AnalysisSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'AnalysisName' => [ 'base' => NULL, 'refs' => [ 'Analysis$Name' => '

The descriptive name of the analysis.

', 'AnalysisSummary$Name' => '

The name of the analysis. This name is displayed in the Amazon QuickSight console.

', 'CreateAnalysisRequest$Name' => '

A descriptive name for the analysis that you\'re creating. This name displays for the analysis in the Amazon QuickSight console.

', 'DescribeAnalysisDefinitionResponse$Name' => '

The descriptive name of the analysis.

', 'UpdateAnalysisRequest$Name' => '

A descriptive name for the analysis that you\'re updating. This name displays for the analysis in the Amazon QuickSight console.

', ], ], 'AnalysisSearchFilter' => [ 'base' => '

A filter that you apply when searching for one or more analyses.

', 'refs' => [ 'AnalysisSearchFilterList$member' => NULL, ], ], 'AnalysisSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchAnalysesRequest$Filters' => '

The structure for the search filters that you want to apply to your search.

', ], ], 'AnalysisSourceEntity' => [ 'base' => '

The source entity of an analysis.

', 'refs' => [ 'CreateAnalysisRequest$SourceEntity' => '

A source entity to use for the analysis that you\'re creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'UpdateAnalysisRequest$SourceEntity' => '

A source entity to use for the analysis that you\'re updating. This metadata structure contains details that describe a source template and one or more datasets.

', ], ], 'AnalysisSourceTemplate' => [ 'base' => '

The source template of an analysis.

', 'refs' => [ 'AnalysisSourceEntity$SourceTemplate' => '

The source template for the source entity of the analysis.

', ], ], 'AnalysisSummary' => [ 'base' => '

The summary metadata that describes an analysis.

', 'refs' => [ 'AnalysisSummaryList$member' => NULL, ], ], 'AnalysisSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAnalysesResponse$AnalysisSummaryList' => '

Metadata describing each of the analyses that are listed.

', 'SearchAnalysesResponse$AnalysisSummaryList' => '

Metadata describing the analyses that you searched for.

', ], ], 'Anchor' => [ 'base' => '

The definition of the Anchor.

', 'refs' => [ 'TopicIRFilterOption$Anchor' => '

The anchor for the TopicIRFilterOption.

', ], ], 'AnchorDateConfiguration' => [ 'base' => '

The date configuration of the filter.

', 'refs' => [ 'RelativeDatesFilter$AnchorDateConfiguration' => '

The date configuration of the filter.

', ], ], 'AnchorOption' => [ 'base' => NULL, 'refs' => [ 'AnchorDateConfiguration$AnchorOption' => '

The options for the date configuration. Choose one of the options below:

', ], ], 'AnchorType' => [ 'base' => NULL, 'refs' => [ 'Anchor$AnchorType' => '

The AnchorType for the Anchor.

', ], ], 'AnonymousUserDashboardEmbeddingConfiguration' => [ 'base' => '

Information about the dashboard that you want to embed.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$Dashboard' => '

The type of embedding experience. In this case, Amazon QuickSight dashboards.

', ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeature' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures$member' => NULL, ], ], 'AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$DisabledFeatures' => '

A list of all disabled features of a specified anonymous dashboard.

', ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeature' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures$member' => NULL, ], ], 'AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$EnabledFeatures' => '

A list of all enabled features of a specified anonymous dashboard.

', ], ], 'AnonymousUserDashboardFeatureConfigurations' => [ 'base' => '

The feature configuration for an embedded dashboard.

', 'refs' => [ 'AnonymousUserDashboardEmbeddingConfiguration$FeatureConfigurations' => '

The feature configuration for an embedded dashboard.

', ], ], 'AnonymousUserDashboardVisualEmbeddingConfiguration' => [ 'base' => '

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$DashboardVisual' => '

The type of embedding experience. In this case, Amazon QuickSight visuals.

', ], ], 'AnonymousUserEmbeddingExperienceConfiguration' => [ 'base' => '

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

', 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$ExperienceConfiguration' => '

The configuration of the experience that you are embedding.

', ], ], 'AnonymousUserGenerativeQnAEmbeddingConfiguration' => [ 'base' => '

The settings that you want to use for the Generative Q&A experience.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$GenerativeQnA' => '

The Generative Q&A experience that you want to use for anonymous user embedding.

', ], ], 'AnonymousUserQSearchBarEmbeddingConfiguration' => [ 'base' => '

The settings that you want to use with the Q search bar.

', 'refs' => [ 'AnonymousUserEmbeddingExperienceConfiguration$QSearchBar' => '

The Q search bar that you want to use for anonymous user embedding.

', ], ], 'AnonymousUserSnapshotJobResult' => [ 'base' => '

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.

', 'refs' => [ 'AnonymousUserSnapshotJobResultList$member' => NULL, ], ], 'AnonymousUserSnapshotJobResultList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobResult$AnonymousUsers' => '

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

', ], ], 'AnswerId' => [ 'base' => NULL, 'refs' => [ 'AnswerIds$member' => NULL, 'CreateTopicReviewedAnswer$AnswerId' => '

The answer ID for the CreateTopicReviewedAnswer.

', 'InvalidTopicReviewedAnswer$AnswerId' => '

The answer ID for the InvalidTopicReviewedAnswer.

', 'SucceededTopicReviewedAnswer$AnswerId' => '

The answer ID for the SucceededTopicReviewedAnswer.

', 'TopicReviewedAnswer$AnswerId' => '

The answer ID of the reviewed answer.

', ], ], 'AnswerIds' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTopicReviewedAnswerRequest$AnswerIds' => '

The Answer IDs of the Answers to be deleted.

', ], ], 'ArcAxisConfiguration' => [ 'base' => '

The arc axis configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartOptions$ArcAxis' => '

The arc axis configuration of a GaugeChartVisual.

', ], ], 'ArcAxisDisplayRange' => [ 'base' => '

The arc axis range of a GaugeChartVisual.

', 'refs' => [ 'ArcAxisConfiguration$Range' => '

The arc axis range of a GaugeChartVisual.

', ], ], 'ArcConfiguration' => [ 'base' => '

The arc configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartOptions$Arc' => '

The arc configuration of a GaugeChartVisual.

', ], ], 'ArcOptions' => [ 'base' => '

The options that determine the arc thickness of a GaugeChartVisual.

', 'refs' => [ 'DonutOptions$ArcOptions' => '

The option for define the arc of the chart shape. Valid values are as follows:

', ], ], 'ArcThickness' => [ 'base' => NULL, 'refs' => [ 'ArcOptions$ArcThickness' => '

The arc thickness of a GaugeChartVisual.

', ], ], 'ArcThicknessOptions' => [ 'base' => NULL, 'refs' => [ 'ArcConfiguration$ArcThickness' => '

The options that determine the arc thickness of a GaugeChartVisual.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AccountCustomization$DefaultTheme' => '

The default theme for this Amazon QuickSight subscription.

', 'AccountCustomization$DefaultEmailCustomizationTemplate' => '

The default email customization template.

', 'ActiveIAMPolicyAssignment$PolicyArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'Analysis$Arn' => '

The Amazon Resource Name (ARN) of the analysis.

', 'Analysis$ThemeArn' => '

The ARN of the theme of the analysis.

', 'AnalysisSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the source template of an analysis.

', 'AnalysisSummary$Arn' => '

The Amazon Resource Name (ARN) for the analysis.

', 'ArnList$member' => NULL, 'AssetBundleExportJobAnalysisOverrideProperties$Arn' => '

The ARN of the specific Analysis resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDashboardOverrideProperties$Arn' => '

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDataSetOverrideProperties$Arn' => '

The ARN of the specific DataSet resource whose override properties are configured in this structure.

', 'AssetBundleExportJobDataSourceOverrideProperties$Arn' => '

The ARN of the specific DataSource resource whose override properties are configured in this structure.

', 'AssetBundleExportJobError$Arn' => '

The ARN of the resource whose processing caused an error.

', 'AssetBundleExportJobRefreshScheduleOverrideProperties$Arn' => '

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

', 'AssetBundleExportJobSummary$Arn' => '

The ARN of the export job.

', 'AssetBundleExportJobThemeOverrideProperties$Arn' => '

The ARN of the specific Theme resource whose override properties are configured in this structure.

', 'AssetBundleExportJobVPCConnectionOverrideProperties$Arn' => '

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

', 'AssetBundleExportJobWarning$Arn' => '

The ARN of the resource whose processing caused a warning.

', 'AssetBundleImportJobError$Arn' => '

The ARN of the resource whose processing caused an error.

', 'AssetBundleImportJobSummary$Arn' => '

The ARN of the import job.

', 'AssetBundleImportJobWarning$Arn' => '

The ARN of the resource that the warning occurred for.

', 'AssetBundleResourceArns$member' => NULL, 'BatchCreateTopicReviewedAnswerResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'BatchDeleteTopicReviewedAnswerResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CancelIngestionResponse$Arn' => '

The Amazon Resource Name (ARN) for the data ingestion.

', 'CreateAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

', 'CreateAnalysisRequest$ThemeArn' => '

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.

', 'CreateAnalysisResponse$Arn' => '

The ARN for the analysis.

', 'CreateDashboardRequest$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

', 'CreateDashboardResponse$Arn' => '

The ARN of the dashboard.

', 'CreateDashboardResponse$VersionArn' => '

The ARN of the dashboard, including the version number of the first version that is created.

', 'CreateDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateDataSetResponse$IngestionArn' => '

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'CreateDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'CreateFolderRequest$ParentFolderArn' => '

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

', 'CreateFolderResponse$Arn' => '

The Amazon Resource Name (ARN) for the newly created folder.

', 'CreateIAMPolicyAssignmentRequest$PolicyArn' => '

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

', 'CreateIAMPolicyAssignmentResponse$PolicyArn' => '

The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.

', 'CreateIngestionResponse$Arn' => '

The Amazon Resource Name (ARN) for the data ingestion.

', 'CreateNamespaceResponse$Arn' => '

The ARN of the Amazon QuickSight namespace you created.

', 'CreateRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'CreateTemplateResponse$Arn' => '

The ARN for the template.

', 'CreateTemplateResponse$VersionArn' => '

The ARN for the template, including the version information of the first version.

', 'CreateThemeResponse$Arn' => '

The Amazon Resource Name (ARN) for the theme.

', 'CreateThemeResponse$VersionArn' => '

The Amazon Resource Name (ARN) for the new theme.

', 'CreateTopicRefreshScheduleRequest$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CreateTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'CreateTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'CreateTopicResponse$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'CreateTopicReviewedAnswer$DatasetArn' => '

The Dataset arn for the CreateTopicReviewedAnswer.

', 'CreateVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'CustomSql$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'Dashboard$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersion$SourceEntityArn' => '

Source entity ARN.

', 'DashboardVersion$ThemeArn' => '

The ARN of the theme associated with a version of the dashboard.

', 'DashboardVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DashboardVersionSummary$SourceEntityArn' => '

Source entity ARN.

', 'DataSet$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DataSetArnsList$member' => NULL, 'DataSetIdentifierDeclaration$DataSetArn' => '

The Amazon Resource Name (ARN) of the data set.

', 'DataSetReference$DataSetArn' => '

Dataset Amazon Resource Name (ARN).

', 'DataSetSummary$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DataSource$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'DataSourceSummary$Arn' => '

The arn of the datasource.

', 'DatasetMetadata$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteAnalysisResponse$Arn' => '

The Amazon Resource Name (ARN) of the deleted analysis.

', 'DeleteDashboardResponse$Arn' => '

The Secure Socket Layer (SSL) properties that apply for the resource.

', 'DeleteDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source that you deleted.

', 'DeleteFolderResponse$Arn' => '

The Amazon Resource Name of the deleted folder.

', 'DeleteRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'DeleteTemplateAliasResponse$Arn' => '

The Amazon Resource Name (ARN) of the template you want to delete.

', 'DeleteTemplateResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DeleteThemeAliasResponse$Arn' => '

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

', 'DeleteThemeResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'DeleteTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DeleteTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DeleteTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DeleteVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the deleted VPC connection.

', 'DescribeAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) of the customization that\'s associated with this Amazon Web Services account.

', 'DescribeAnalysisDefinitionResponse$ThemeArn' => '

The ARN of the theme of the analysis.

', 'DescribeAnalysisPermissionsResponse$AnalysisArn' => '

The Amazon Resource Name (ARN) of the analysis whose permissions you\'re describing.

', 'DescribeAssetBundleExportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the export job.

', 'DescribeAssetBundleImportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the import job.

', 'DescribeDashboardDefinitionResponse$ThemeArn' => '

The ARN of the theme of the dashboard.

', 'DescribeDashboardPermissionsResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'DescribeDashboardSnapshotJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResultResponse$Arn' => '

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDataSetPermissionsResponse$DataSetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DescribeDataSourcePermissionsResponse$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'DescribeFolderPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) for the folder.

', 'DescribeFolderResolvedPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'DescribeRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'DescribeTemplateDefinitionResponse$ThemeArn' => '

The ARN of the theme of the template.

', 'DescribeTemplatePermissionsResponse$TemplateArn' => '

The Amazon Resource Name (ARN) of the template.

', 'DescribeThemePermissionsResponse$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme.

', 'DescribeTopicPermissionsResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DescribeTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'DescribeTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'DescribeTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'Folder$Arn' => '

The Amazon Resource Name (ARN) for the folder.

', 'FolderArnList$member' => NULL, 'FolderSummary$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'GenerateEmbedUrlForAnonymousUserResponse$AnonymousUserArn' => '

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

', 'GenerateEmbedUrlForRegisteredUserRequest$UserArn' => '

The Amazon Resource Name for the registered user.

', 'GetDashboardEmbedUrlRequest$UserArn' => '

The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

', 'GetSessionEmbedUrlRequest$UserArn' => '

The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

  1. Active Directory (AD) users or group members

  2. Invited nonfederated users

  3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

', 'Group$Arn' => '

The Amazon Resource Name (ARN) for the group.

', 'GroupMember$Arn' => '

The Amazon Resource Name (ARN) for the group member (user).

', 'IAMPolicyAssignment$PolicyArn' => '

The Amazon Resource Name (ARN) for the IAM policy.

', 'Ingestion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

', 'ListTopicRefreshSchedulesResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'ListTopicReviewedAnswersResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'LogicalTableSource$DataSetArn' => '

The Amazon Resource Number (ARN) of the parent dataset.

', 'MemberIdArnPair$MemberArn' => '

The Amazon Resource Name (ARN) of the member.

', 'NamespaceInfoV2$Arn' => '

The namespace ARN.

', 'Path$member' => NULL, 'RefreshSchedule$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'RelationalTable$DataSourceArn' => '

The Amazon Resource Name (ARN) for the data source.

', 'RestoreAnalysisResponse$Arn' => '

The Amazon Resource Name (ARN) of the analysis that you\'re restoring.

', 'RowLevelPermissionDataSet$Arn' => '

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

', 'S3Source$DataSourceArn' => '

The Amazon Resource Name (ARN) for the data source.

', 'StartAssetBundleExportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the export job.

', 'StartAssetBundleImportJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the import job.

', 'StartDashboardSnapshotJobResponse$Arn' => '

The Amazon Resource Name (ARN) for the dashboard snapshot job.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'Template$Arn' => '

The Amazon Resource Name (ARN) of the template.

', 'TemplateAlias$Arn' => '

The Amazon Resource Name (ARN) of the template alias.

', 'TemplateSourceAnalysis$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TemplateSourceTemplate$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TemplateSummary$Arn' => '

A summary of a template.

', 'TemplateVersion$SourceEntityArn' => '

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

', 'TemplateVersion$ThemeArn' => '

The ARN of the theme associated with this version of the template.

', 'TemplateVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the template version.

', 'Theme$Arn' => '

The Amazon Resource Name (ARN) of the theme.

', 'ThemeAlias$Arn' => '

The Amazon Resource Name (ARN) of the theme alias.

', 'ThemeSummary$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ThemeVersion$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ThemeVersionSummary$Arn' => '

The Amazon Resource Name (ARN) of the theme version.

', 'TopicRefreshDetails$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'TopicRefreshScheduleSummary$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'TopicReviewedAnswer$Arn' => '

The Amazon Resource Name (ARN) of the reviewed answer.

', 'TopicReviewedAnswer$DatasetArn' => '

The Dataset ARN for the TopicReviewedAnswer.

', 'TopicSummary$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to untag.

', 'UpdateAccountCustomizationResponse$Arn' => '

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

', 'UpdateAnalysisPermissionsResponse$AnalysisArn' => '

The Amazon Resource Name (ARN) of the analysis that you updated.

', 'UpdateAnalysisRequest$ThemeArn' => '

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.

', 'UpdateAnalysisResponse$Arn' => '

The ARN of the analysis that you\'re updating.

', 'UpdateDashboardLinksResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardPermissionsResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardPublishedVersionResponse$DashboardArn' => '

The Amazon Resource Name (ARN) of the dashboard.

', 'UpdateDashboardRequest$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

', 'UpdateDashboardResponse$Arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UpdateDashboardResponse$VersionArn' => '

The ARN of the dashboard, including the version number.

', 'UpdateDataSetPermissionsResponse$DataSetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateDataSetResponse$Arn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateDataSetResponse$IngestionArn' => '

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'UpdateDataSourcePermissionsResponse$DataSourceArn' => '

The Amazon Resource Name (ARN) of the data source.

', 'UpdateDataSourceResponse$Arn' => '

The Amazon Resource Name (ARN) of the data source.

', 'UpdateFolderPermissionsResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'UpdateFolderResponse$Arn' => '

The Amazon Resource Name (ARN) of the folder.

', 'UpdateIAMPolicyAssignmentRequest$PolicyArn' => '

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

', 'UpdateIAMPolicyAssignmentResponse$PolicyArn' => '

The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

', 'UpdateRefreshScheduleResponse$Arn' => '

The Amazon Resource Name (ARN) for the refresh schedule.

', 'UpdateTemplatePermissionsResponse$TemplateArn' => '

The Amazon Resource Name (ARN) of the template.

', 'UpdateTemplateResponse$Arn' => '

The Amazon Resource Name (ARN) for the template.

', 'UpdateTemplateResponse$VersionArn' => '

The ARN for the template, including the version information of the first version.

', 'UpdateThemePermissionsResponse$ThemeArn' => '

The Amazon Resource Name (ARN) of the theme.

', 'UpdateThemeResponse$Arn' => '

The Amazon Resource Name (ARN) for the theme.

', 'UpdateThemeResponse$VersionArn' => '

The Amazon Resource Name (ARN) for the new version of the theme.

', 'UpdateTopicPermissionsResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicRefreshScheduleResponse$TopicArn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicRefreshScheduleResponse$DatasetArn' => '

The Amazon Resource Name (ARN) of the dataset.

', 'UpdateTopicResponse$Arn' => '

The Amazon Resource Name (ARN) of the topic.

', 'UpdateTopicResponse$RefreshArn' => '

The Amazon Resource Name (ARN) of the topic refresh.

', 'UpdateVPCConnectionResponse$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'User$Arn' => '

The Amazon Resource Name (ARN) for the user.

', 'VPCConnection$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'VPCConnectionSummary$Arn' => '

The Amazon Resource Name (ARN) of the VPC connection.

', 'VpcConnectionProperties$VpcConnectionArn' => '

The Amazon Resource Name (ARN) for the VPC connection.

', ], ], 'ArnList' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$AuthorizedResourceArns' => '

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.

', ], ], 'AssetBundleCloudFormationOverridePropertyConfiguration' => [ 'base' => '

An optional collection of CloudFormation property configurations that control how the export job is generated.

', 'refs' => [ 'DescribeAssetBundleExportJobResponse$CloudFormationOverridePropertyConfiguration' => '

The CloudFormation override property configuration for the export job.

', 'StartAssetBundleExportJobRequest$CloudFormationOverridePropertyConfiguration' => '

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

', ], ], 'AssetBundleExportFormat' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobSummary$ExportFormat' => '

The format for the export job.

', 'DescribeAssetBundleExportJobResponse$ExportFormat' => '

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

', 'StartAssetBundleExportJobRequest$ExportFormat' => '

The export data format.

', ], ], 'AssetBundleExportJobAnalysisOverrideProperties' => [ 'base' => '

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobAnalysisOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobAnalysisOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Analyses' => '

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobAnalysisPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobAnalysisPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobAnalysisPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobAnalysisOverrideProperties$Properties' => '

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDashboardOverrideProperties' => [ 'base' => '

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDashboardOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDashboardOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Dashboards' => '

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDashboardPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDashboardPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDashboardPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDashboardOverrideProperties$Properties' => '

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSetOverrideProperties' => [ 'base' => '

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDataSetOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDataSetOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$DataSets' => '

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSetPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSetPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDataSetPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSetOverrideProperties$Properties' => '

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSourceOverrideProperties' => [ 'base' => '

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobDataSourceOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobDataSourceOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$DataSources' => '

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobDataSourcePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSourcePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobDataSourcePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobDataSourceOverrideProperties$Properties' => '

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobError' => [ 'base' => '

Describes an error that occurred during an Asset Bundle export job.

', 'refs' => [ 'AssetBundleExportJobErrorList$member' => NULL, ], ], 'AssetBundleExportJobErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$Errors' => '

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

', ], ], 'AssetBundleExportJobRefreshScheduleOverrideProperties' => [ 'base' => '

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobRefreshScheduleOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobRefreshScheduleOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$RefreshSchedules' => '

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobRefreshSchedulePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobRefreshScheduleOverrideProperties$Properties' => '

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobResourceIdOverrideConfiguration' => [ 'base' => '

An optional structure that configures resource ID overrides for the export job.

', 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$ResourceIdOverrideConfiguration' => '

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobSummary$JobStatus' => '

The current status of the export job.

', 'DescribeAssetBundleExportJobResponse$JobStatus' => '

Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

', ], ], 'AssetBundleExportJobSummary' => [ 'base' => '

A summary of the export job that includes details of the job\'s configuration and its current status.

', 'refs' => [ 'AssetBundleExportJobSummaryList$member' => NULL, ], ], 'AssetBundleExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAssetBundleExportJobsResponse$AssetBundleExportJobSummaryList' => '

A list of export job summaries.

', ], ], 'AssetBundleExportJobThemeOverrideProperties' => [ 'base' => '

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobThemeOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobThemeOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$Themes' => '

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobThemePropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobThemePropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobThemePropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobThemeOverrideProperties$Properties' => '

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobVPCConnectionOverrideProperties' => [ 'base' => '

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

', 'refs' => [ 'AssetBundleExportJobVPCConnectionOverridePropertiesList$member' => NULL, ], ], 'AssetBundleExportJobVPCConnectionOverridePropertiesList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleCloudFormationOverridePropertyConfiguration$VPCConnections' => '

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverride' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobVPCConnectionPropertyToOverrideList$member' => NULL, ], ], 'AssetBundleExportJobVPCConnectionPropertyToOverrideList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleExportJobVPCConnectionOverrideProperties$Properties' => '

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

', ], ], 'AssetBundleExportJobValidationStrategy' => [ 'base' => '

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

', 'refs' => [ 'DescribeAssetBundleExportJobResponse$ValidationStrategy' => '

The validation strategy that is used to export the analysis or dashboard.

', 'StartAssetBundleExportJobRequest$ValidationStrategy' => '

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

', ], ], 'AssetBundleExportJobWarning' => [ 'base' => '

Describes a warning that occurred during an Asset Bundle export job.

', 'refs' => [ 'AssetBundleExportJobWarningList$member' => NULL, ], ], 'AssetBundleExportJobWarningList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$Warnings' => '

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

', ], ], 'AssetBundleImportBodyBlob' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSource$Body' => '

The bytes of the base64 encoded asset bundle import zip file. This file can\'t exceed 20 MB.

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file\'s bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.

', ], ], 'AssetBundleImportFailureAction' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobSummary$FailureAction' => '

The failure action for the import job.

', 'DescribeAssetBundleImportJobResponse$FailureAction' => '

The failure action for the import job.

', 'StartAssetBundleImportJobRequest$FailureAction' => '

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.

', ], ], 'AssetBundleImportJobAnalysisOverrideParameters' => [ 'base' => '

The override parameters for a single analysis that is being imported.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Analyses' => '

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobAnalysisOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of analysis IDs.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Analyses' => '

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobAnalysisOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of analysis IDs.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobAnalysisOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Analyses' => '

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverrideParameters' => [ 'base' => '

The override parameters for a single dashboard that is being imported.

', 'refs' => [ 'AssetBundleImportJobDashboardOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Dashboards' => '

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of dashboard IDs.

', 'refs' => [ 'AssetBundleImportJobDashboardOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Dashboards' => '

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDashboardOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of dashboard IDs.

', 'refs' => [ 'AssetBundleImportJobDashboardOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDashboardOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Dashboards' => '

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverrideParameters' => [ 'base' => '

The override parameters for a single dataset that is being imported.

', 'refs' => [ 'AssetBundleImportJobDataSetOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$DataSets' => '

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of dataset IDs.

', 'refs' => [ 'AssetBundleImportJobDataSetOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$DataSets' => '

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSetOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of dataset IDs.

', 'refs' => [ 'AssetBundleImportJobDataSetOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDataSetOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$DataSets' => '

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceCredentialPair' => [ 'base' => '

A username and password credential pair to use to import a data source resource.

', 'refs' => [ 'AssetBundleImportJobDataSourceCredentials$CredentialPair' => '

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

', ], ], 'AssetBundleImportJobDataSourceCredentials' => [ 'base' => '

The login credentials to use to import a data source resource.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$Credentials' => '

An optional structure that provides the credentials to be used to create the imported data source.

', ], ], 'AssetBundleImportJobDataSourceOverrideParameters' => [ 'base' => '

The override parameters for a single data source that is being imported.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$DataSources' => '

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of data source IDs.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$DataSources' => '

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobDataSourceOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of data source IDs.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobDataSourceOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$DataSources' => '

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobError' => [ 'base' => '

Describes an error that occurred within an Asset Bundle import execution.

', 'refs' => [ 'AssetBundleImportJobErrorList$member' => NULL, ], ], 'AssetBundleImportJobErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleImportJobResponse$Errors' => '

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

', 'DescribeAssetBundleImportJobResponse$RollbackErrors' => '

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

', ], ], 'AssetBundleImportJobOverrideParameters' => [ 'base' => '

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideParameters' => '

Optional overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideParameters' => '

Optional overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverridePermissions' => [ 'base' => '

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverridePermissions' => '

Optional permission overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverridePermissions' => '

Optional permission overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverrideTags' => [ 'base' => '

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideTags' => '

Optional tag overrides that are applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideTags' => '

Optional tag overrides that are applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobOverrideValidationStrategy' => [ 'base' => '

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$OverrideValidationStrategy' => '

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

', 'StartAssetBundleImportJobRequest$OverrideValidationStrategy' => '

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

', ], ], 'AssetBundleImportJobRefreshScheduleOverrideParameters' => [ 'base' => '

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

', 'refs' => [ 'AssetBundleImportJobRefreshScheduleOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobRefreshScheduleOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$RefreshSchedules' => '

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobResourceIdOverrideConfiguration' => [ 'base' => '

An optional structure that configures resource ID overrides for the import job.

', 'refs' => [ 'AssetBundleImportJobOverrideParameters$ResourceIdOverrideConfiguration' => '

An optional structure that configures resource ID overrides to be applied within the import job.

', ], ], 'AssetBundleImportJobStatus' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobSummary$JobStatus' => '

The current status of the import job.

', 'DescribeAssetBundleImportJobResponse$JobStatus' => '

Indicates the status of a job through its queuing and execution.

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

', ], ], 'AssetBundleImportJobSummary' => [ 'base' => '

A summary of the import job that includes details of the requested job\'s configuration and its current status.

', 'refs' => [ 'AssetBundleImportJobSummaryList$member' => NULL, ], ], 'AssetBundleImportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAssetBundleImportJobsResponse$AssetBundleImportJobSummaryList' => '

A list of import job summaries.

', ], ], 'AssetBundleImportJobThemeOverrideParameters' => [ 'base' => '

The override parameters for a single theme that is imported.

', 'refs' => [ 'AssetBundleImportJobThemeOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$Themes' => '

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobThemeOverridePermissions' => [ 'base' => '

An object that contains a list of permissions to be applied to a list of theme IDs.

', 'refs' => [ 'AssetBundleImportJobThemeOverridePermissionsList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverridePermissionsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverridePermissions$Themes' => '

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobThemeOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of theme IDs.

', 'refs' => [ 'AssetBundleImportJobThemeOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobThemeOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$Themes' => '

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobVPCConnectionOverrideParameters' => [ 'base' => '

The override parameters for a single VPC connection that is imported.

', 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParametersList$member' => NULL, ], ], 'AssetBundleImportJobVPCConnectionOverrideParametersList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideParameters$VPCConnections' => '

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobVPCConnectionOverrideTags' => [ 'base' => '

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

', 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideTagsList$member' => NULL, ], ], 'AssetBundleImportJobVPCConnectionOverrideTagsList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobOverrideTags$VPCConnections' => '

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

', ], ], 'AssetBundleImportJobWarning' => [ 'base' => '

Describes a warning that occurred during an Asset Bundle import job.

', 'refs' => [ 'AssetBundleImportJobWarningList$member' => NULL, ], ], 'AssetBundleImportJobWarningList' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleImportJobResponse$Warnings' => '

An array of warning records that describe all permitted errors that are encountered during the import job.

', ], ], 'AssetBundleImportSource' => [ 'base' => '

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

', 'refs' => [ 'StartAssetBundleImportJobRequest$AssetBundleImportSource' => '

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

', ], ], 'AssetBundleImportSourceDescription' => [ 'base' => '

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

', 'refs' => [ 'DescribeAssetBundleImportJobResponse$AssetBundleImportSource' => '

The source of the asset bundle zip file that contains the data that is imported by the job.

', ], ], 'AssetBundlePrincipalList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleResourcePermissions$Principals' => '

A list of principals to grant permissions on.

', ], ], 'AssetBundleResourceArns' => [ 'base' => NULL, 'refs' => [ 'DescribeAssetBundleExportJobResponse$ResourceArns' => '

A list of resource ARNs that exported with the job.

', 'StartAssetBundleExportJobRequest$ResourceArns' => '

An array of resource ARNs to export. The following resources are supported.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

', ], ], 'AssetBundleResourceLinkSharingConfiguration' => [ 'base' => '

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

', 'refs' => [ 'AssetBundleImportJobDashboardOverridePermissions$LinkSharingConfiguration' => '

A structure that contains the link sharing configurations that you want to apply overrides to.

', ], ], 'AssetBundleResourcePermissions' => [ 'base' => '

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

', 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissions$Permissions' => '

A list of permissions for the analyses that you want to apply overrides to.

', 'AssetBundleImportJobDashboardOverridePermissions$Permissions' => '

A list of permissions for the dashboards that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverridePermissions$Permissions' => '

A list of permissions for the datasets that you want to apply overrides to.

', 'AssetBundleImportJobDataSourceOverridePermissions$Permissions' => '

A list of permissions for the data source that you want to apply overrides to.

', 'AssetBundleImportJobThemeOverridePermissions$Permissions' => '

A list of permissions for the themes that you want to apply overrides to.

', 'AssetBundleResourceLinkSharingConfiguration$Permissions' => '

A list of link sharing permissions for the dashboards that you want to apply overrides to.

', ], ], 'AssetBundleRestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AssetBundleRestrictiveResourceIdList$member' => NULL, ], ], 'AssetBundleRestrictiveResourceIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverridePermissions$AnalysisIds' => '

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

', 'AssetBundleImportJobAnalysisOverrideTags$AnalysisIds' => '

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

', 'AssetBundleImportJobDashboardOverridePermissions$DashboardIds' => '

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

', 'AssetBundleImportJobDashboardOverrideTags$DashboardIds' => '

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

', 'AssetBundleImportJobDataSetOverridePermissions$DataSetIds' => '

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

', 'AssetBundleImportJobDataSetOverrideTags$DataSetIds' => '

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

', 'AssetBundleImportJobDataSourceOverridePermissions$DataSourceIds' => '

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

', 'AssetBundleImportJobDataSourceOverrideTags$DataSourceIds' => '

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

', 'AssetBundleImportJobThemeOverridePermissions$ThemeIds' => '

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

', 'AssetBundleImportJobThemeOverrideTags$ThemeIds' => '

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

', 'AssetBundleImportJobVPCConnectionOverrideTags$VPCConnectionIds' => '

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

', ], ], 'AssetOptions' => [ 'base' => '

An array of analysis level configurations.

', 'refs' => [ 'AnalysisDefinition$Options' => '

An array of option definitions for an analysis.

', 'DashboardVersionDefinition$Options' => '

An array of option definitions for a dashboard.

', 'TemplateVersionDefinition$Options' => '

An array of option definitions for a template.

', ], ], 'AssignmentStatus' => [ 'base' => NULL, 'refs' => [ 'CreateIAMPolicyAssignmentRequest$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'CreateIAMPolicyAssignmentResponse$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'IAMPolicyAssignment$AssignmentStatus' => '

Assignment status.

', 'IAMPolicyAssignmentSummary$AssignmentStatus' => '

Assignment status.

', 'ListIAMPolicyAssignmentsRequest$AssignmentStatus' => '

The status of the assignments.

', 'UpdateIAMPolicyAssignmentRequest$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', 'UpdateIAMPolicyAssignmentResponse$AssignmentStatus' => '

The status of the assignment. Possible values are as follows:

', ], ], 'AthenaParameters' => [ 'base' => '

Parameters for Amazon Athena.

', 'refs' => [ 'DataSourceParameters$AthenaParameters' => '

The parameters for Amazon Athena.

', ], ], 'AttributeAggregationFunction' => [ 'base' => '

Aggregation for attributes.

', 'refs' => [ 'AggregationFunction$AttributeAggregationFunction' => '

Aggregation for attributes.

', ], ], 'AuroraParameters' => [ 'base' => '

Parameters for Amazon Aurora.

', 'refs' => [ 'DataSourceParameters$AuroraParameters' => '

The parameters for Amazon Aurora MySQL.

', ], ], 'AuroraPostgreSqlParameters' => [ 'base' => '

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

', 'refs' => [ 'DataSourceParameters$AuroraPostgreSqlParameters' => '

The parameters for Amazon Aurora.

', ], ], 'AuthenticationMethodOption' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AuthenticationMethod' => '

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.

', ], ], 'AuthorSpecifiedAggregation' => [ 'base' => NULL, 'refs' => [ 'AuthorSpecifiedAggregations$member' => NULL, ], ], 'AuthorSpecifiedAggregations' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$AllowedAggregations' => '

The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicCalculatedField$NotAllowedAggregations' => '

The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicColumn$AllowedAggregations' => '

The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', 'TopicColumn$NotAllowedAggregations' => '

The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

', ], ], 'AuthorizedTargetsByService' => [ 'base' => '

The authorized targets that are associated with a service.

', 'refs' => [ 'AuthorizedTargetsByServices$member' => NULL, ], ], 'AuthorizedTargetsByServices' => [ 'base' => NULL, 'refs' => [ 'ListIdentityPropagationConfigsResponse$Services' => '

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

', ], ], 'AuthorizedTargetsList' => [ 'base' => NULL, 'refs' => [ 'AuthorizedTargetsByService$AuthorizedTargets' => '

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

', 'UpdateIdentityPropagationConfigRequest$AuthorizedTargets' => '

Specifies a list of application ARNs that represent the authorized targets for a service.

', ], ], 'AwsAccountId' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

', 'BatchDeleteTopicReviewedAnswerRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

', 'CancelIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

', 'CreateAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

', 'CreateAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that you\'re using to create your Amazon QuickSight account.

', 'CreateAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you are creating an analysis.

', 'CreateDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to create the dashboard.

', 'CreateDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateFolderMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'CreateFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account where you want to create the folder.

', 'CreateGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

', 'CreateIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

', 'CreateRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'CreateRoleMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

', 'CreateTemplateRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'CreateThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

', 'CreateThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to store the new theme.

', 'CreateTopicRefreshScheduleRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic you\'re creating a refresh schedule for.

', 'CreateTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to create a topic in.

', 'CreateVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account where you want to create a new VPC connection.

', 'DeleteAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

', 'DeleteAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that you want to delete.

', 'DeleteAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account where you want to delete an analysis.

', 'DeleteDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re deleting.

', 'DeleteDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteFolderMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DeleteFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DeleteGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteIAMPolicyAssignmentRequest$AwsAccountId' => '

The Amazon Web Services account ID where you want to delete the IAM policy assignment.

', 'DeleteIdentityPropagationConfigRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

', 'DeleteNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

', 'DeleteRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteRoleMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the item to delete.

', 'DeleteTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re deleting.

', 'DeleteThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias to delete.

', 'DeleteThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re deleting.

', 'DeleteTopicRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DeleteTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to delete.

', 'DeleteUserByPrincipalIdRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DeleteVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account where you want to delete a VPC connection.

', 'DescribeAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

', 'DescribeAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you\'re describing.

', 'DescribeAccountSettingsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the settings that you want to list.

', 'DescribeAccountSubscriptionRequest$AwsAccountId' => '

The Amazon Web Services account ID associated with your Amazon QuickSight account.

', 'DescribeAnalysisDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAnalysisPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis whose permissions you\'re describing. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

', 'DescribeAssetBundleExportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account the export job is executed in.

', 'DescribeAssetBundleExportJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that the export job was executed in.

', 'DescribeAssetBundleImportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account the import job was executed in.

', 'DescribeAssetBundleImportJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account the import job was executed in.

', 'DescribeDashboardDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing.

', 'DescribeDashboardPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing permissions for.

', 'DescribeDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re describing.

', 'DescribeDashboardSnapshotJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDashboardSnapshotJobResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDashboardSnapshotJobResultRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'DescribeDataSetPermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSourcePermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeFolderPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeFolderResolvedPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'DescribeGroupMembershipRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the assignment that you want to describe.

', 'DescribeIngestionRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeIpRestrictionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'DescribeIpRestrictionResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'DescribeKeyRegistrationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

', 'DescribeKeyRegistrationResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

', 'DescribeNamespaceRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

', 'DescribeRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template alias that you\'re describing.

', 'DescribeTemplateDefinitionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

', 'DescribeTemplatePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re describing.

', 'DescribeTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re describing.

', 'DescribeThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias that you\'re describing.

', 'DescribeThemePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re describing.

', 'DescribeTopicPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want described.

', 'DescribeTopicRefreshRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

', 'DescribeTopicRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeTopicRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'DescribeUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'DescribeVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connection that you want described.

', 'GenerateEmbedUrlForAnonymousUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GenerateEmbedUrlForRegisteredUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GetDashboardEmbedUrlRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the dashboard that you\'re embedding.

', 'GetSessionEmbedUrlRequest$AwsAccountId' => '

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

', 'IAMPolicyAssignment$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListAnalysesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analyses.

', 'ListAssetBundleExportJobsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the export jobs were executed in.

', 'ListAssetBundleImportJobsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the import jobs were executed in.

', 'ListDashboardVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re listing versions for.

', 'ListDashboardsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboards that you\'re listing.

', 'ListDataSetsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListDataSourcesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListFolderMembersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'ListFoldersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'ListGroupMembershipsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListGroupsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListIAMPolicyAssignmentsForUserRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the assignments.

', 'ListIAMPolicyAssignmentsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains these IAM policy assignments.

', 'ListIdentityPropagationConfigsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

', 'ListIngestionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListNamespacesRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

', 'ListRefreshSchedulesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'ListRoleMembershipsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListTemplateAliasesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template aliases that you\'re listing.

', 'ListTemplateVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the templates that you\'re listing.

', 'ListTemplatesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the templates that you\'re listing.

', 'ListThemeAliasesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme aliases that you\'re listing.

', 'ListThemeVersionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the themes that you\'re listing.

', 'ListThemesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the themes that you\'re listing.

', 'ListTopicRefreshSchedulesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.

', 'ListTopicReviewedAnswersRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

', 'ListTopicsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topics that you want to list.

', 'ListUserGroupsRequest$AwsAccountId' => '

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListUsersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'ListVPCConnectionsRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.

', 'PutDataSetRefreshPropertiesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'RegisterUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'RestoreAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis.

', 'SearchAnalysesRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analyses that you\'re searching for.

', 'SearchDashboardsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the user whose dashboards you\'re searching for.

', 'SearchDataSetsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'SearchDataSourcesRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'SearchFoldersRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder.

', 'SearchGroupsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'StartAssetBundleExportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account to export assets from.

', 'StartAssetBundleImportJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account to import assets into.

', 'StartDashboardSnapshotJobRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

', 'UpdateAccountCustomizationRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountCustomizationResponse$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountSettingsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

', 'UpdateAnalysisPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis whose permissions you\'re updating. You must be using the Amazon Web Services account that the analysis is in.

', 'UpdateAnalysisRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the analysis that you\'re updating.

', 'UpdateDashboardLinksRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

', 'UpdateDashboardPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard whose permissions you\'re updating.

', 'UpdateDashboardPublishedVersionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re updating.

', 'UpdateDashboardRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the dashboard that you\'re updating.

', 'UpdateDataSetPermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSetRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSourcePermissionsRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateDataSourceRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateFolderPermissionsRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder to update.

', 'UpdateFolderRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that contains the folder to update.

', 'UpdateGroupRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateIAMPolicyAssignmentRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IAM policy assignment.

', 'UpdateIdentityPropagationConfigRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

', 'UpdateIpRestrictionRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'UpdateIpRestrictionResponse$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the IP rules.

', 'UpdateKeyRegistrationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

', 'UpdatePublicSharingSettingsRequest$AwsAccountId' => '

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

', 'UpdateRefreshScheduleRequest$AwsAccountId' => '

The Amazon Web Services account ID.

', 'UpdateRoleCustomPermissionRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateSPICECapacityConfigurationRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

', 'UpdateTemplateAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template alias that you\'re updating.

', 'UpdateTemplatePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template.

', 'UpdateTemplateRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the template that you\'re updating.

', 'UpdateThemeAliasRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme alias that you\'re updating.

', 'UpdateThemePermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme.

', 'UpdateThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re updating.

', 'UpdateTopicPermissionsRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.

', 'UpdateTopicRefreshScheduleRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.

', 'UpdateTopicRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the topic that you want to update.

', 'UpdateUserRequest$AwsAccountId' => '

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

', 'UpdateVPCConnectionRequest$AwsAccountId' => '

The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.

', ], ], 'AwsAndAccountId' => [ 'base' => NULL, 'refs' => [ 'DescribeThemeRequest$AwsAccountId' => '

The ID of the Amazon Web Services account that contains the theme that you\'re describing.

', ], ], 'AwsIotAnalyticsParameters' => [ 'base' => '

The parameters for IoT Analytics.

', 'refs' => [ 'DataSourceParameters$AwsIotAnalyticsParameters' => '

The parameters for IoT Analytics.

', ], ], 'AxisBinding' => [ 'base' => NULL, 'refs' => [ 'DataFieldSeriesItem$AxisBinding' => '

The axis that you are binding the field to.

', 'FieldSeriesItem$AxisBinding' => '

The axis that you are binding the field to.

', 'LineChartDefaultSeriesSettings$AxisBinding' => '

The axis to which you are binding all line series to.

', 'ReferenceLineDataConfiguration$AxisBinding' => '

The axis binding type of the reference line. Choose one of the following options:

', ], ], 'AxisDataOptions' => [ 'base' => '

The data options for an axis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AxisDisplayOptions$DataOptions' => '

The data options for an axis.

', ], ], 'AxisDisplayDataDrivenRange' => [ 'base' => '

The options that are saved for future extension.

', 'refs' => [ 'AxisDisplayRange$DataDriven' => '

The data-driven setup of an axis display range.

', ], ], 'AxisDisplayMinMaxRange' => [ 'base' => '

The minimum and maximum setup for an axis display range.

', 'refs' => [ 'AxisDisplayRange$MinMax' => '

The minimum and maximum setup of an axis display range.

', ], ], 'AxisDisplayOptions' => [ 'base' => '

The display options for the axis label.

', 'refs' => [ 'BarChartConfiguration$CategoryAxis' => '

The label display options (grid line, range, scale, axis step) for bar chart category.

', 'BarChartConfiguration$ValueAxis' => '

The label display options (grid line, range, scale, axis step) for a bar chart value.

', 'BoxPlotChartConfiguration$CategoryAxis' => '

The label display options (grid line, range, scale, axis step) of a box plot category.

', 'BoxPlotChartConfiguration$PrimaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, axis step) of a box plot category.

', 'ComboChartConfiguration$CategoryAxis' => '

The category axis of a combo chart.

', 'ComboChartConfiguration$PrimaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of a combo chart\'s primary y-axis (bar) field well.

', 'ComboChartConfiguration$SecondaryYAxisDisplayOptions' => '

The label display options (grid line, range, scale, axis step) of a combo chart\'s secondary y-axis (line) field well.

', 'HistogramConfiguration$XAxisDisplayOptions' => '

The options that determine the presentation of the x-axis.

', 'HistogramConfiguration$YAxisDisplayOptions' => '

The options that determine the presentation of the y-axis.

', 'LineChartConfiguration$XAxisDisplayOptions' => '

The options that determine the presentation of the x-axis.

', 'LineSeriesAxisDisplayOptions$AxisOptions' => '

The options that determine the presentation of the line series axis.

', 'RadarChartConfiguration$CategoryAxis' => '

The category axis of a radar chart.

', 'RadarChartConfiguration$ColorAxis' => '

The color axis of a radar chart.

', 'ScatterPlotConfiguration$XAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of the scatter plot\'s x-axis.

', 'ScatterPlotConfiguration$YAxisDisplayOptions' => '

The label display options (grid line, range, scale, and axis step) of the scatter plot\'s y-axis.

', 'WaterfallChartConfiguration$CategoryAxisDisplayOptions' => '

The options that determine the presentation of the category axis.

', 'WaterfallChartConfiguration$PrimaryYAxisDisplayOptions' => '

The options that determine the presentation of the y-axis.

', ], ], 'AxisDisplayRange' => [ 'base' => '

The range setup of a numeric axis display range.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'NumericAxisOptions$Range' => '

The range setup of a numeric axis.

', ], ], 'AxisLabelOptions' => [ 'base' => '

The label options for a chart axis. You must specify the field that the label is targeted to.

', 'refs' => [ 'AxisLabelOptionsList$member' => NULL, ], ], 'AxisLabelOptionsList' => [ 'base' => NULL, 'refs' => [ 'ChartAxisLabelOptions$AxisLabelOptions' => '

The label options for a chart axis.

', ], ], 'AxisLabelReferenceOptions' => [ 'base' => '

The reference that specifies where the axis label is applied to.

', 'refs' => [ 'AxisLabelOptions$ApplyTo' => '

The options that indicate which field the label belongs to.

', ], ], 'AxisLinearScale' => [ 'base' => '

The liner axis scale setup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'AxisScale$Linear' => '

The linear axis scale setup.

', ], ], 'AxisLogarithmicScale' => [ 'base' => '

The logarithmic axis scale setup.

', 'refs' => [ 'AxisScale$Logarithmic' => '

The logarithmic axis scale setup.

', ], ], 'AxisScale' => [ 'base' => '

The scale setup options for a numeric axis display.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'NumericAxisOptions$Scale' => '

The scale setup of a numeric axis.

', ], ], 'AxisTickLabelOptions' => [ 'base' => '

The tick label options of an axis.

', 'refs' => [ 'AxisDisplayOptions$TickLabelOptions' => '

The tick label options of an axis.

', ], ], 'BarChartAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a bar chart.

', 'refs' => [ 'BarChartFieldWells$BarChartAggregatedFieldWells' => '

The aggregated field wells of a bar chart.

', ], ], 'BarChartConfiguration' => [ 'base' => '

The configuration of a BarChartVisual.

', 'refs' => [ 'BarChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'BarChartFieldWells' => [ 'base' => '

The field wells of a BarChartVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'BarChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'BarChartOrientation' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$Orientation' => '

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

', ], ], 'BarChartSortConfiguration' => [ 'base' => '

sort-configuration-description

', 'refs' => [ 'BarChartConfiguration$SortConfiguration' => '

The sort configuration of a BarChartVisual.

', ], ], 'BarChartVisual' => [ 'base' => '

A bar chart.

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

For more information, see Using bar charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$BarChartVisual' => '

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

', ], ], 'BarsArrangement' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$BarsArrangement' => '

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

', 'ComboChartConfiguration$BarsArrangement' => '

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

', ], ], 'BaseMapStyleType' => [ 'base' => NULL, 'refs' => [ 'GeospatialMapStyleOptions$BaseMapStyle' => '

The base map style of the geospatial map.

', ], ], 'BatchCreateTopicReviewedAnswerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreateTopicReviewedAnswerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTopicReviewedAnswerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTopicReviewedAnswerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BigQueryParameters' => [ 'base' => '

The parameters that are required to connect to a Google BigQuery data source.

', 'refs' => [ 'DataSourceParameters$BigQueryParameters' => '

The parameters that are required to connect to a Google BigQuery data source.

', ], ], 'BinCountLimit' => [ 'base' => NULL, 'refs' => [ 'BinWidthOptions$BinCountLimit' => '

The options that determine the bin count limit.

', ], ], 'BinCountOptions' => [ 'base' => '

The options that determine the bin count of a histogram.

', 'refs' => [ 'HistogramBinOptions$BinCount' => '

The options that determine the bin count of a histogram.

', ], ], 'BinCountValue' => [ 'base' => NULL, 'refs' => [ 'BinCountOptions$Value' => '

The options that determine the bin count value.

', ], ], 'BinWidthOptions' => [ 'base' => '

The options that determine the bin width of a histogram.

', 'refs' => [ 'HistogramBinOptions$BinWidth' => '

The options that determine the bin width of a histogram.

', ], ], 'BinWidthValue' => [ 'base' => NULL, 'refs' => [ 'BinWidthOptions$Value' => '

The options that determine the bin width value.

', ], ], 'BodySectionConfiguration' => [ 'base' => '

The configuration of a body section.

', 'refs' => [ 'BodySectionConfigurationList$member' => NULL, ], ], 'BodySectionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutConfiguration$BodySections' => '

A list of body section configurations.

', ], ], 'BodySectionContent' => [ 'base' => '

The configuration of content in a body section.

', 'refs' => [ 'BodySectionConfiguration$Content' => '

The configuration of content in a body section.

', ], ], 'BodySectionDynamicCategoryDimensionConfiguration' => [ 'base' => '

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

', 'refs' => [ 'BodySectionRepeatDimensionConfiguration$DynamicCategoryDimensionConfiguration' => '

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

', ], ], 'BodySectionDynamicDimensionLimit' => [ 'base' => NULL, 'refs' => [ 'BodySectionDynamicCategoryDimensionConfiguration$Limit' => '

Number of values to use from the column for repetition.

', 'BodySectionDynamicNumericDimensionConfiguration$Limit' => '

Number of values to use from the column for repetition.

', ], ], 'BodySectionDynamicDimensionSortConfigurationList' => [ 'base' => NULL, 'refs' => [ 'BodySectionDynamicCategoryDimensionConfiguration$SortByMetrics' => '

Sort criteria on the column values that you use for repetition.

', 'BodySectionDynamicNumericDimensionConfiguration$SortByMetrics' => '

Sort criteria on the column values that you use for repetition.

', ], ], 'BodySectionDynamicNumericDimensionConfiguration' => [ 'base' => '

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

', 'refs' => [ 'BodySectionRepeatDimensionConfiguration$DynamicNumericDimensionConfiguration' => '

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

', ], ], 'BodySectionRepeatConfiguration' => [ 'base' => '

Describes the configurations that are required to declare a section as repeating.

', 'refs' => [ 'BodySectionConfiguration$RepeatConfiguration' => '

Describes the configurations that are required to declare a section as repeating.

', ], ], 'BodySectionRepeatDimensionConfiguration' => [ 'base' => '

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

', 'refs' => [ 'BodySectionRepeatDimensionConfigurationList$member' => NULL, ], ], 'BodySectionRepeatDimensionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'BodySectionRepeatConfiguration$DimensionConfigurations' => '

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

', ], ], 'BodySectionRepeatPageBreakConfiguration' => [ 'base' => '

The page break configuration to apply for each repeating instance.

', 'refs' => [ 'BodySectionRepeatConfiguration$PageBreakConfiguration' => '

Page break configuration to apply for each repeating instance.

', ], ], 'BookmarksConfigurations' => [ 'base' => '

The bookmarks configuration of an embedded dashboard.

', 'refs' => [ 'RegisteredUserDashboardFeatureConfigurations$Bookmarks' => '

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$PublicSharingEnabled' => '

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.

', 'AccountSettings$TerminationProtectionEnabled' => '

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.

', 'AssetBundleExportJobResourceIdOverrideConfiguration$PrefixForAllResources' => '

An option to request a CloudFormation variable for a prefix to be prepended to each resource\'s ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

', 'AssetBundleExportJobSummary$IncludeAllDependencies' => '

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

', 'AssetBundleExportJobSummary$IncludePermissions' => '

The flag that determines the inclusion of permissions associated with each resource ARN.

', 'AssetBundleExportJobSummary$IncludeTags' => '

The flag that determines the inclusion of tags associated with each resource ARN.

', 'AssetBundleExportJobValidationStrategy$StrictModeForAllResources' => '

A Boolean value that indicates whether to export resources under strict or lenient mode.

', 'AssetBundleImportJobOverrideValidationStrategy$StrictModeForAllResources' => '

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

', 'BookmarksConfigurations$Enabled' => '

A Boolean value that determines whether a user can bookmark an embedded dashboard.

', 'BorderStyle$Show' => '

The option to enable display of borders for visuals.

', 'DataSetSummary$RowLevelPermissionTagConfigurationApplied' => '

Whether or not the row level permission tags are applied.

', 'DataSetSummary$ColumnLevelPermissionRulesApplied' => '

A value that indicates if the dataset has column level permission configured.

', 'DataSetUsageConfiguration$DisableUseAsDirectQuerySource' => '

An option that controls whether a child dataset of a direct query can use this dataset as a source.

', 'DataSetUsageConfiguration$DisableUseAsImportedSource' => '

An option that controls whether a child dataset that\'s stored in QuickSight can use this dataset as a source.

', 'DeleteAnalysisRequest$ForceDeleteWithoutRecovery' => '

This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can\'t restore an analysis after it\'s deleted.

', 'DescribeAssetBundleExportJobResponse$IncludeAllDependencies' => '

The include dependencies flag.

', 'DescribeAssetBundleExportJobResponse$IncludePermissions' => '

The include permissions flag.

', 'DescribeAssetBundleExportJobResponse$IncludeTags' => '

The include tags flag.

', 'DescribeKeyRegistrationRequest$DefaultKeyOnly' => '

Determines whether the request returns the default key only.

', 'DisplayFormatOptions$UseBlankCellFormat' => '

A Boolean value that indicates whether to use blank cell format.

', 'DisplayFormatOptions$UseGrouping' => '

A Boolean value that indicates whether to use grouping.

', 'FailedKeyRegistrationEntry$SenderFault' => '

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.

', 'GetDashboardEmbedUrlRequest$UndoRedoDisabled' => '

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

', 'GetDashboardEmbedUrlRequest$ResetDisabled' => '

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

', 'GetDashboardEmbedUrlRequest$StatePersistenceEnabled' => '

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.

', 'GutterStyle$Show' => '

This Boolean value controls whether to display a gutter space between sheet tiles.

', 'IdentityCenterConfiguration$EnableIdentityPropagation' => '

A Boolean option that controls whether Trusted Identity Propagation should be used.

', 'JoinKeyProperties$UniqueKey' => '

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.

', 'MarginStyle$Show' => '

This Boolean value controls whether to display sheet margins.

', 'NestedFilter$IncludeInnerSet' => '

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

', 'NumericRangeFilter$IncludeMinimum' => '

Determines whether the minimum value in the filter value range should be included in the filtered results.

', 'NumericRangeFilter$IncludeMaximum' => '

Determines whether the maximum value in the filter value range should be included in the filtered results.

', 'RedshiftIAMParameters$AutoCreateDatabaseUser' => '

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.

', 'RegisteredCustomerManagedKey$DefaultKey' => '

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

', 'SharedViewConfigurations$Enabled' => '

The shared view settings of an embedded dashboard.

', 'SignupResponse$IAMUser' => '

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.

', 'SslProperties$DisableSsl' => '

A Boolean option to control whether SSL should be disabled.

', 'StartAssetBundleExportJobRequest$IncludeAllDependencies' => '

A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

', 'StartAssetBundleExportJobRequest$IncludePermissions' => '

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

', 'StartAssetBundleExportJobRequest$IncludeTags' => '

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

', 'StatePersistenceConfigurations$Enabled' => '

Determines if a Amazon QuickSight dashboard\'s state persistence settings are turned on or off.

', 'TimeRangeFilter$IncludeMinimum' => '

Determines whether the minimum value in the filter value range should be included in the filtered results.

', 'TimeRangeFilter$IncludeMaximum' => '

Determines whether the maximum value in the filter value range should be included in the filtered results.

', 'TopicCalculatedField$IsIncludedInTopic' => '

A boolean value that indicates if a calculated field is included in the topic.

', 'TopicCalculatedField$NeverAggregateInFilter' => '

A Boolean value that indicates whether to never aggregate calculated field in filters.

', 'TopicCategoryFilter$Inverse' => '

A Boolean value that indicates if the filter is inverse.

', 'TopicColumn$IsIncludedInTopic' => '

A Boolean value that indicates whether the column is included in the query results.

', 'TopicColumn$NeverAggregateInFilter' => '

A Boolean value that indicates whether to aggregate the column data when it\'s used in a filter context.

', 'TopicDateRangeFilter$Inclusive' => '

A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.

', 'TopicIRFilterOption$Inverse' => '

The inverse for the TopicIRFilterOption.

', 'TopicIRFilterOption$Inclusive' => '

The inclusive for the TopicIRFilterOption.

', 'TopicNumericRangeFilter$Inclusive' => '

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

', 'TopicRefreshSchedule$BasedOnSpiceSchedule' => '

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

', 'UpdateAccountSettingsRequest$TerminationProtectionEnabled' => '

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.

', 'UpdatePublicSharingSettingsRequest$PublicSharingEnabled' => '

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

', 'UpdateUserRequest$UnapplyCustomPermissions' => '

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn\'t accept any other value.

', 'UploadSettings$ContainsHeader' => '

Whether the file has a header row, or the files each have a header row.

', 'User$Active' => '

The active status of user. When you create an Amazon QuickSight user that\'s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'CustomValuesConfiguration$IncludeNullValue' => '

Includes the null value in custom action parameter values.

', ], ], 'BorderStyle' => [ 'base' => '

The display options for tile borders for visuals.

', 'refs' => [ 'TileStyle$Border' => '

The border around a tile.

', ], ], 'BoxPlotAggregatedFieldWells' => [ 'base' => '

The aggregated field well for a box plot.

', 'refs' => [ 'BoxPlotFieldWells$BoxPlotAggregatedFieldWells' => '

The aggregated field wells of a box plot.

', ], ], 'BoxPlotChartConfiguration' => [ 'base' => '

The configuration of a BoxPlotVisual.

', 'refs' => [ 'BoxPlotVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'BoxPlotDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BoxPlotAggregatedFieldWells$GroupBy' => '

The group by field well of a box plot chart. Values are grouped based on group by fields.

', ], ], 'BoxPlotFieldWells' => [ 'base' => '

The field wells of a BoxPlotVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'BoxPlotChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'BoxPlotFillStyle' => [ 'base' => NULL, 'refs' => [ 'BoxPlotStyleOptions$FillStyle' => '

The fill styles (solid, transparent) of the box plot.

', ], ], 'BoxPlotMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'BoxPlotAggregatedFieldWells$Values' => '

The value field well of a box plot chart. Values are aggregated based on group by fields.

', ], ], 'BoxPlotOptions' => [ 'base' => '

The options of a box plot visual.

', 'refs' => [ 'BoxPlotChartConfiguration$BoxPlotOptions' => '

The box plot chart options for a box plot visual

', ], ], 'BoxPlotSortConfiguration' => [ 'base' => '

The sort configuration of a BoxPlotVisual.

', 'refs' => [ 'BoxPlotChartConfiguration$SortConfiguration' => '

The sort configuration of a BoxPlotVisual.

', ], ], 'BoxPlotStyleOptions' => [ 'base' => '

The style options of the box plot.

', 'refs' => [ 'BoxPlotOptions$StyleOptions' => '

The style options of the box plot.

', ], ], 'BoxPlotVisual' => [ 'base' => '

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$BoxPlotVisual' => '

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'IpRestrictionRuleMap$key' => NULL, ], ], 'CalculatedColumn' => [ 'base' => '

A calculated column for a dataset.

', 'refs' => [ 'CalculatedColumnList$member' => NULL, ], ], 'CalculatedColumnList' => [ 'base' => NULL, 'refs' => [ 'CreateColumnsOperation$Columns' => '

Calculated columns to create.

', ], ], 'CalculatedField' => [ 'base' => '

The calculated field of an analysis.

', 'refs' => [ 'CalculatedFields$member' => NULL, ], ], 'CalculatedFieldExpression' => [ 'base' => NULL, 'refs' => [ 'CalculatedField$Expression' => '

The expression of the calculated field.

', ], ], 'CalculatedFieldReferenceList' => [ 'base' => NULL, 'refs' => [ 'TopicIRMetric$CalculatedFieldReferences' => '

The calculated field references for the TopicIRMetric.

', ], ], 'CalculatedFields' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$CalculatedFields' => '

An array of calculated field definitions for the analysis.

', 'DashboardVersionDefinition$CalculatedFields' => '

An array of calculated field definitions for the dashboard.

', 'TemplateVersionDefinition$CalculatedFields' => '

An array of calculated field definitions for the template.

', ], ], 'CalculatedMeasureField' => [ 'base' => '

The table calculation measure field for pivot tables.

', 'refs' => [ 'MeasureField$CalculatedMeasureField' => '

The calculated measure field only used in pivot tables.

', ], ], 'CancelIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CascadingControlConfiguration' => [ 'base' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'refs' => [ 'FilterCrossSheetControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'FilterDropDownControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'FilterListControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'ParameterDropDownControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', 'ParameterListControl$CascadingControlConfiguration' => '

The values that are displayed in a control can be configured to only show values that are valid based on what\'s selected in other controls.

', ], ], 'CascadingControlSource' => [ 'base' => '

The source controls that are used in a CascadingControlConfiguration.

', 'refs' => [ 'CascadingControlSourceList$member' => NULL, ], ], 'CascadingControlSourceList' => [ 'base' => NULL, 'refs' => [ 'CascadingControlConfiguration$SourceControls' => '

A list of source controls that determine the values that are used in the current control.

', ], ], 'CastColumnTypeOperation' => [ 'base' => '

A transform operation that casts a column to a different type.

', 'refs' => [ 'TransformOperation$CastColumnTypeOperation' => '

A transform operation that casts a column to a different type.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'PrestoParameters$Catalog' => '

Catalog.

', 'StarburstParameters$Catalog' => '

The catalog name for the Starburst data source.

', 'TrinoParameters$Catalog' => '

The catalog name for the Trino data source.

', ], ], 'CategoricalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AggregationFunction$CategoricalAggregationFunction' => '

Aggregation for categorical values.

', 'CategoricalMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', ], ], 'CategoricalDimensionField' => [ 'base' => '

The dimension type field with categorical type columns..

', 'refs' => [ 'DimensionField$CategoricalDimensionField' => '

The dimension type field with categorical type columns.

', ], ], 'CategoricalMeasureField' => [ 'base' => '

The measure type field with categorical type columns.

', 'refs' => [ 'MeasureField$CategoricalMeasureField' => '

The measure type field with categorical type columns.

', ], ], 'CategoryDrillDownFilter' => [ 'base' => '

The category drill down filter.

', 'refs' => [ 'DrillDownFilter$CategoryFilter' => '

The category type drill down filter. This filter is used for string type columns.

', ], ], 'CategoryFilter' => [ 'base' => '

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

', 'refs' => [ 'Filter$CategoryFilter' => '

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

', ], ], 'CategoryFilterConfiguration' => [ 'base' => '

The configuration for a CategoryFilter.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CategoryFilter$Configuration' => '

The configuration for a CategoryFilter.

', 'CategoryInnerFilter$Configuration' => NULL, ], ], 'CategoryFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicCategoryFilter$CategoryFilterFunction' => '

The category filter function. Valid values for this structure are EXACT and CONTAINS.

', ], ], 'CategoryFilterMatchOperator' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', 'CustomFilterListConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', 'FilterListConfiguration$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', ], ], 'CategoryFilterSelectAllOptions' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'CustomFilterListConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'FilterListConfiguration$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', ], ], 'CategoryFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicCategoryFilter$CategoryFilterType' => '

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

', ], ], 'CategoryInnerFilter' => [ 'base' => '

A CategoryInnerFilter filters text values for the NestedFilter.

', 'refs' => [ 'InnerFilter$CategoryInnerFilter' => '

A CategoryInnerFilter filters text values for the NestedFilter.

', ], ], 'CategoryValue' => [ 'base' => NULL, 'refs' => [ 'CategoryValueList$member' => NULL, 'CustomFilterConfiguration$CategoryValue' => '

The category value for the filter.

This field is mutually exclusive to ParameterName.

', ], ], 'CategoryValueList' => [ 'base' => NULL, 'refs' => [ 'CategoryDrillDownFilter$CategoryValues' => '

A list of the string inputs that are the values of the category drill down filter.

', 'CustomFilterListConfiguration$CategoryValues' => '

The list of category values for the filter.

', 'FilterListConfiguration$CategoryValues' => '

The list of category values for the filter.

', ], ], 'CellValueSynonym' => [ 'base' => '

A structure that represents the cell value synonym.

', 'refs' => [ 'CellValueSynonyms$member' => NULL, ], ], 'CellValueSynonyms' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$CellValueSynonyms' => '

The other names or aliases for the calculated field cell value.

', 'TopicColumn$CellValueSynonyms' => '

The other names or aliases for the column cell value.

', ], ], 'ChartAxisLabelOptions' => [ 'base' => '

The label options for an axis on a chart.

', 'refs' => [ 'BarChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a bar chart.

', 'BarChartConfiguration$ValueLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

', 'BarChartConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

', 'BoxPlotChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

', 'BoxPlotChartConfiguration$PrimaryYAxisLabelOptions' => '

The label options (label text, label visibility and sort icon visibility) of a box plot value.

', 'ComboChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

', 'ComboChartConfiguration$PrimaryYAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s primary y-axis (bar) field well.

', 'ComboChartConfiguration$SecondaryYAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s secondary y-axis(line) field well.

', 'ComboChartConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of a combo chart\'s color field well.

', 'FunnelChartConfiguration$CategoryLabelOptions' => '

The label options of the categories that are displayed in a FunnelChartVisual.

', 'FunnelChartConfiguration$ValueLabelOptions' => '

The label options for the values that are displayed in a FunnelChartVisual.

', 'HeatMapConfiguration$RowLabelOptions' => '

The label options of the row that is displayed in a heat map.

', 'HeatMapConfiguration$ColumnLabelOptions' => '

The label options of the column that is displayed in a heat map.

', 'HistogramConfiguration$XAxisLabelOptions' => '

The options that determine the presentation of the x-axis label.

', 'LineChartConfiguration$XAxisLabelOptions' => '

The options that determine the presentation of the x-axis label.

', 'LineChartConfiguration$PrimaryYAxisLabelOptions' => '

The options that determine the presentation of the y-axis label.

', 'LineChartConfiguration$SecondaryYAxisLabelOptions' => '

The options that determine the presentation of the secondary y-axis label.

', 'PieChartConfiguration$CategoryLabelOptions' => '

The label options of the group/color that is displayed in a pie chart.

', 'PieChartConfiguration$ValueLabelOptions' => '

The label options for the value that is displayed in a pie chart.

', 'RadarChartConfiguration$CategoryLabelOptions' => '

The category label options of a radar chart.

', 'RadarChartConfiguration$ColorLabelOptions' => '

The color label options of a radar chart.

', 'ScatterPlotConfiguration$XAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of the scatter plot\'s x-axis.

', 'ScatterPlotConfiguration$YAxisLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) of the scatter plot\'s y-axis.

', 'TreeMapConfiguration$GroupLabelOptions' => '

The label options (label text, label visibility) of the groups that are displayed in a tree map.

', 'TreeMapConfiguration$SizeLabelOptions' => '

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

', 'TreeMapConfiguration$ColorLabelOptions' => '

The label options (label text, label visibility) for the colors displayed in a tree map.

', 'WaterfallChartConfiguration$CategoryAxisLabelOptions' => '

The options that determine the presentation of the category axis label.

', 'WaterfallChartConfiguration$PrimaryYAxisLabelOptions' => '

The options that determine the presentation of the y-axis label.

', 'WordCloudChartConfiguration$CategoryLabelOptions' => '

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

', ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'RedshiftParameters$ClusterId' => '

Cluster ID. This field can be blank if the Host and Port are provided.

', ], ], 'ClusterMarker' => [ 'base' => '

The cluster marker that is a part of the cluster marker configuration.

', 'refs' => [ 'ClusterMarkerConfiguration$ClusterMarker' => '

The cluster marker that is a part of the cluster marker configuration.

', ], ], 'ClusterMarkerConfiguration' => [ 'base' => '

The cluster marker configuration of the geospatial map selected point style.

', 'refs' => [ 'GeospatialPointStyleOptions$ClusterMarkerConfiguration' => '

The cluster marker configuration of the geospatial point style.

', ], ], 'CollectiveConstant' => [ 'base' => '

A structure that represents a collective constant.

', 'refs' => [ 'TopicCategoryFilterConstant$CollectiveConstant' => '

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

', ], ], 'CollectiveConstantEntry' => [ 'base' => '

The definition for a CollectiveConstantEntry.

', 'refs' => [ 'CollectiveConstantEntryList$member' => NULL, ], ], 'CollectiveConstantEntryList' => [ 'base' => NULL, 'refs' => [ 'TopicConstantValue$ValueList' => '

The value list of the TopicConstantValue.

', ], ], 'ColorFillType' => [ 'base' => NULL, 'refs' => [ 'ColorScale$ColorFillType' => '

Determines the color fill type.

', ], ], 'ColorList' => [ 'base' => NULL, 'refs' => [ 'DataColorPalette$Colors' => '

The hexadecimal codes for the colors.

', 'DataColorPalette$MinMaxGradient' => '

The minimum and maximum hexadecimal codes that describe a color gradient.

', ], ], 'ColorScale' => [ 'base' => '

Determines the color scale that is applied to the visual.

', 'refs' => [ 'HeatMapConfiguration$ColorScale' => '

The color options (gradient color, point of divergence) in a heat map.

', 'TreeMapConfiguration$ColorScale' => '

The color options (gradient color, point of divergence) of a tree map.

', ], ], 'ColorScaleColorList' => [ 'base' => NULL, 'refs' => [ 'ColorScale$Colors' => '

Determines the list of colors that are applied to the visual.

', ], ], 'ColorsConfiguration' => [ 'base' => '

The color configurations for a column.

', 'refs' => [ 'ColumnConfiguration$ColorsConfiguration' => '

The color configurations of the column.

', ], ], 'ColumnConfiguration' => [ 'base' => '

The general configuration of a column.

', 'refs' => [ 'ColumnConfigurationList$member' => NULL, ], ], 'ColumnConfigurationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$ColumnConfigurations' => '

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

', 'DashboardVersionDefinition$ColumnConfigurations' => '

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

', 'TemplateVersionDefinition$ColumnConfigurations' => '

An array of template-level column configurations. Column configurations are used to set default formatting for a column that\'s used throughout a template.

', ], ], 'ColumnDataRole' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$ColumnDataRole' => '

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

', 'TopicColumn$ColumnDataRole' => '

The role of the column in the data. Valid values are DIMENSION and MEASURE.

', ], ], 'ColumnDataSubType' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$SubType' => '

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

', 'InputColumn$SubType' => '

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

', 'OutputColumn$SubType' => '

The sub data type of the column.

', ], ], 'ColumnDataType' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$NewColumnType' => '

New column data type.

', 'OutputColumn$Type' => '

The data type of the column.

', ], ], 'ColumnDescription' => [ 'base' => '

Metadata that contains a description for a column.

', 'refs' => [ 'ColumnTag$ColumnDescription' => '

A description for a column.

', ], ], 'ColumnDescriptiveText' => [ 'base' => NULL, 'refs' => [ 'ColumnDescription$Text' => '

The text of a description for a column.

', 'OutputColumn$Description' => '

A description for a column.

', ], ], 'ColumnGroup' => [ 'base' => '

Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'ColumnGroupList$member' => NULL, ], ], 'ColumnGroupColumnSchema' => [ 'base' => '

A structure describing the name, data type, and geographic role of the columns.

', 'refs' => [ 'ColumnGroupColumnSchemaList$member' => NULL, ], ], 'ColumnGroupColumnSchemaList' => [ 'base' => NULL, 'refs' => [ 'ColumnGroupSchema$ColumnGroupColumnSchemaList' => '

A structure containing the list of schemas for column group columns.

', ], ], 'ColumnGroupList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', 'DataSet$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', 'UpdateDataSetRequest$ColumnGroups' => '

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

', ], ], 'ColumnGroupName' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$Name' => '

A display name for the hierarchy.

', ], ], 'ColumnGroupSchema' => [ 'base' => '

The column group schema.

', 'refs' => [ 'ColumnGroupSchemaList$member' => NULL, ], ], 'ColumnGroupSchemaList' => [ 'base' => NULL, 'refs' => [ 'DataSetConfiguration$ColumnGroupSchemaList' => '

A structure containing the list of column group schemas.

', ], ], 'ColumnHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields for a visual element.

', 'refs' => [ 'ColumnHierarchyList$member' => NULL, ], ], 'ColumnHierarchyList' => [ 'base' => NULL, 'refs' => [ 'BarChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'BoxPlotVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'ComboChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'FilledMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'FunnelChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'GeospatialMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'HeatMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'KPIVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'LineChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'PieChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'RadarChartVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'ScatterPlotVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'TreeMapVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'WaterfallVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', 'WordCloudVisual$ColumnHierarchies' => '

The column hierarchy that is used during drill-downs and drill-ups.

', ], ], 'ColumnId' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$ColumnId' => '

A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.

', ], ], 'ColumnIdentifier' => [ 'base' => '

A column of a data set.

', 'refs' => [ 'AggregationSortConfiguration$Column' => '

The column that determines the sort order of aggregated values.

', 'AxisLabelReferenceOptions$Column' => '

The column that the axis label is targeted to.

', 'BodySectionDynamicCategoryDimensionConfiguration$Column' => NULL, 'BodySectionDynamicNumericDimensionConfiguration$Column' => NULL, 'CascadingControlSource$ColumnToMatch' => '

The column identifier that determines which column to look up for the source sheet control.

', 'CategoricalDimensionField$Column' => '

The column that is used in the CategoricalDimensionField.

', 'CategoricalMeasureField$Column' => '

The column that is used in the CategoricalMeasureField.

', 'CategoryDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'CategoryFilter$Column' => '

The column that the filter is applied to.

', 'CategoryInnerFilter$Column' => NULL, 'ColumnConfiguration$Column' => '

The column.

', 'ColumnSort$SortBy' => NULL, 'ColumnTooltipItem$Column' => '

The target column of the tooltip item.

', 'ContributorDimensionList$member' => NULL, 'CustomActionColumnList$member' => NULL, 'DateDimensionField$Column' => '

The column that is used in the DateDimensionField.

', 'DateMeasureField$Column' => '

The column that is used in the DateMeasureField.

', 'DestinationParameterValueConfiguration$SourceColumn' => NULL, 'DynamicDefaultValue$UserNameColumn' => '

The column that contains the username.

', 'DynamicDefaultValue$GroupNameColumn' => '

The column that contains the group name.

', 'DynamicDefaultValue$DefaultValueColumn' => '

The column that contains the default value of each user or group.

', 'ExplicitHierarchyColumnList$member' => NULL, 'NestedFilter$Column' => '

The column that the filter is applied to.

', 'NumericEqualityDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'NumericEqualityFilter$Column' => '

The column that the filter is applied to.

', 'NumericRangeFilter$Column' => '

The column that the filter is applied to.

', 'NumericalDimensionField$Column' => '

The column that is used in the NumericalDimensionField.

', 'NumericalMeasureField$Column' => '

The column that is used in the NumericalMeasureField.

', 'ParameterSelectableValues$LinkToDataSetColumn' => '

The column identifier that fetches values from the data set.

', 'PredefinedHierarchyColumnList$member' => NULL, 'ReferenceLineDynamicDataConfiguration$Column' => '

The column that the dynamic data targets.

', 'RelativeDatesFilter$Column' => '

The column that the filter is applied to.

', 'TimeEqualityFilter$Column' => '

The column that the filter is applied to.

', 'TimeRangeDrillDownFilter$Column' => '

The column that the filter is applied to.

', 'TimeRangeFilter$Column' => '

The column that the filter is applied to.

', 'TopBottomFilter$Column' => '

The column that the filter is applied to.

', 'UnaggregatedField$Column' => '

The column that is used in the UnaggregatedField.

', ], ], 'ColumnLevelPermissionRule' => [ 'base' => '

A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

', 'refs' => [ 'ColumnLevelPermissionRuleList$member' => NULL, ], ], 'ColumnLevelPermissionRuleList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', 'DataSet$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', 'UpdateDataSetRequest$ColumnLevelPermissionRules' => '

A set of one or more definitions of a ColumnLevelPermissionRule .

', ], ], 'ColumnList' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$Columns' => '

Columns in this hierarchy.

', ], ], 'ColumnName' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$ColumnName' => '

Column name.

', 'CalculatedField$Name' => '

The name of the calculated field.

', 'CastColumnTypeOperation$ColumnName' => '

Column name.

', 'ColumnIdentifier$ColumnName' => '

The name of the column.

', 'ColumnList$member' => NULL, 'InputColumn$Name' => '

The name of this column in the underlying data source.

', 'OutputColumn$Name' => '

The display name of the column..

', 'RenameColumnOperation$ColumnName' => '

The name of the column to be renamed.

', 'RenameColumnOperation$NewColumnName' => '

The new name for the column.

', 'TagColumnOperation$ColumnName' => '

The column that this operation acts on.

', 'UntagColumnOperation$ColumnName' => '

The column that this operation acts on.

', ], ], 'ColumnNameList' => [ 'base' => NULL, 'refs' => [ 'ColumnLevelPermissionRule$ColumnNames' => '

An array of column names.

', ], ], 'ColumnOrderingType' => [ 'base' => NULL, 'refs' => [ 'ComparativeOrder$UseOrdering' => '

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

', ], ], 'ColumnRole' => [ 'base' => NULL, 'refs' => [ 'ColumnConfiguration$Role' => '

The role of the column.

', ], ], 'ColumnSchema' => [ 'base' => '

The column schema.

', 'refs' => [ 'ColumnSchemaList$member' => NULL, ], ], 'ColumnSchemaList' => [ 'base' => NULL, 'refs' => [ 'DataSetSchema$ColumnSchemaList' => '

A structure containing the list of column schemas.

', ], ], 'ColumnSort' => [ 'base' => '

The sort configuration for a column that is not used in a field well.

', 'refs' => [ 'BodySectionDynamicDimensionSortConfigurationList$member' => NULL, 'FieldSortOptions$ColumnSort' => '

The sort configuration for a column that is not used in a field well.

', 'PivotTableSortBy$Column' => '

The column sort (field id, direction) for the pivot table sort by options.

', ], ], 'ColumnTag' => [ 'base' => '

A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'ColumnTagList$member' => NULL, ], ], 'ColumnTagList' => [ 'base' => NULL, 'refs' => [ 'TagColumnOperation$Tags' => '

The dataset column tag, currently only used for geospatial type tagging.

This is not tags for the Amazon Web Services tagging feature.

', ], ], 'ColumnTagName' => [ 'base' => NULL, 'refs' => [ 'ColumnTagNames$member' => NULL, ], ], 'ColumnTagNames' => [ 'base' => NULL, 'refs' => [ 'UntagColumnOperation$TagNames' => '

The column tags to remove from this column.

', ], ], 'ColumnTooltipItem' => [ 'base' => '

The tooltip item for the columns that are not part of a field well.

', 'refs' => [ 'TooltipItem$ColumnTooltipItem' => '

The tooltip item for the columns that are not part of a field well.

', ], ], 'ComboChartAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a combo chart.

', 'refs' => [ 'ComboChartFieldWells$ComboChartAggregatedFieldWells' => '

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

', ], ], 'ComboChartConfiguration' => [ 'base' => '

The configuration of a ComboChartVisual.

', 'refs' => [ 'ComboChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'ComboChartFieldWells' => [ 'base' => '

The field wells of the visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComboChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'ComboChartSortConfiguration' => [ 'base' => '

The sort configuration of a ComboChartVisual.

', 'refs' => [ 'ComboChartConfiguration$SortConfiguration' => '

The sort configuration of a ComboChartVisual.

', ], ], 'ComboChartVisual' => [ 'base' => '

A combo chart.

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

For more information, see Using combo charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$ComboChartVisual' => '

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

', ], ], 'ComparativeOrder' => [ 'base' => '

A structure that represents a comparative order.

', 'refs' => [ 'TopicCalculatedField$ComparativeOrder' => '

The order in which data is displayed for the calculated field when it\'s used in a comparative context.

', 'TopicColumn$ComparativeOrder' => '

The order in which data is displayed for the column when it\'s used in a comparative context.

', ], ], 'ComparisonConfiguration' => [ 'base' => '

The comparison display configuration of a KPI or gauge chart.

', 'refs' => [ 'GaugeChartOptions$Comparison' => '

The comparison configuration of a GaugeChartVisual.

', 'KPIOptions$Comparison' => '

The comparison configuration of a KPI visual.

', ], ], 'ComparisonFormatConfiguration' => [ 'base' => '

The format of the comparison.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComparisonConfiguration$ComparisonFormat' => '

The format of the comparison.

', ], ], 'ComparisonMethod' => [ 'base' => NULL, 'refs' => [ 'ComparisonConfiguration$ComparisonMethod' => '

The method of the comparison. Choose from the following options:

', ], ], 'ComparisonMethodType' => [ 'base' => NULL, 'refs' => [ 'TopicIRComparisonMethod$Type' => '

The type for the TopicIRComparisonMethod.

', ], ], 'Computation' => [ 'base' => '

The computation union that is used in an insight visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ComputationList$member' => NULL, ], ], 'ComputationList' => [ 'base' => NULL, 'refs' => [ 'InsightConfiguration$Computations' => '

The computations configurations of the insight visual

', ], ], 'ConcurrentUpdatingException' => [ 'base' => '

A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.

', 'refs' => [], ], 'ConditionalFormattingColor' => [ 'base' => '

The formatting configuration for the color.

', 'refs' => [ 'GaugeChartArcConditionalFormatting$ForegroundColor' => '

The conditional formatting of the arc foreground color.

', 'GaugeChartPrimaryValueConditionalFormatting$TextColor' => '

The conditional formatting of the primary value text color.

', 'KPIActualValueConditionalFormatting$TextColor' => '

The conditional formatting of the actual value\'s text color.

', 'KPIComparisonValueConditionalFormatting$TextColor' => '

The conditional formatting of the comparison value\'s text color.

', 'KPIPrimaryValueConditionalFormatting$TextColor' => '

The conditional formatting of the primary value\'s text color.

', 'KPIProgressBarConditionalFormatting$ForegroundColor' => '

The conditional formatting of the progress bar\'s foreground color.

', 'ShapeConditionalFormat$BackgroundColor' => '

The conditional formatting for the shape background color of a filled map visual.

', 'TableRowConditionalFormatting$BackgroundColor' => '

The conditional formatting color (solid, gradient) of the background for a table row.

', 'TableRowConditionalFormatting$TextColor' => '

The conditional formatting color (solid, gradient) of the text for a table row.

', 'TextConditionalFormat$BackgroundColor' => '

The conditional formatting for the text background color.

', 'TextConditionalFormat$TextColor' => '

The conditional formatting for the text color.

', ], ], 'ConditionalFormattingCustomIconCondition' => [ 'base' => '

Determines the custom condition for an icon set.

', 'refs' => [ 'ConditionalFormattingIcon$CustomCondition' => '

Determines the custom condition for an icon set.

', ], ], 'ConditionalFormattingCustomIconOptions' => [ 'base' => '

Custom icon options for an icon set.

', 'refs' => [ 'ConditionalFormattingCustomIconCondition$IconOptions' => '

Custom icon options for an icon set.

', ], ], 'ConditionalFormattingGradientColor' => [ 'base' => '

Formatting configuration for gradient color.

', 'refs' => [ 'ConditionalFormattingColor$Gradient' => '

Formatting configuration for gradient color.

', ], ], 'ConditionalFormattingIcon' => [ 'base' => '

The formatting configuration for the icon.

', 'refs' => [ 'GaugeChartPrimaryValueConditionalFormatting$Icon' => '

The conditional formatting of the primary value icon.

', 'KPIActualValueConditionalFormatting$Icon' => '

The conditional formatting of the actual value\'s icon.

', 'KPIComparisonValueConditionalFormatting$Icon' => '

The conditional formatting of the comparison value\'s icon.

', 'KPIPrimaryValueConditionalFormatting$Icon' => '

The conditional formatting of the primary value\'s icon.

', 'TextConditionalFormat$Icon' => '

The conditional formatting for the icon.

', ], ], 'ConditionalFormattingIconDisplayConfiguration' => [ 'base' => '

Determines the icon display configuration.

', 'refs' => [ 'ConditionalFormattingCustomIconCondition$DisplayConfiguration' => '

Determines the icon display configuration.

', ], ], 'ConditionalFormattingIconDisplayOption' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingIconDisplayConfiguration$IconDisplayOption' => '

Determines the icon display configuration.

', ], ], 'ConditionalFormattingIconSet' => [ 'base' => '

Formatting configuration for icon set.

', 'refs' => [ 'ConditionalFormattingIcon$IconSet' => '

Formatting configuration for icon set.

', ], ], 'ConditionalFormattingIconSetType' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingIconSet$IconSetType' => '

Determines the icon set type.

', ], ], 'ConditionalFormattingSolidColor' => [ 'base' => '

Formatting configuration for solid color.

', 'refs' => [ 'ConditionalFormattingColor$Solid' => '

Formatting configuration for solid color.

', ], ], 'ConflictException' => [ 'base' => '

Updating or deleting a resource can cause an inconsistent state.

', 'refs' => [], ], 'ConstantType' => [ 'base' => NULL, 'refs' => [ 'CollectiveConstantEntry$ConstantType' => '

The ConstantType of a CollectiveConstantEntry.

', 'TopicCategoryFilterConstant$ConstantType' => '

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

', 'TopicConstantValue$ConstantType' => '

The constant type of a TopicConstantValue.

', 'TopicRangeFilterConstant$ConstantType' => '

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

', 'TopicSingularFilterConstant$ConstantType' => '

The type of the singular filter constant. Valid values for this structure are SINGULAR.

', ], ], 'ConstantValueString' => [ 'base' => NULL, 'refs' => [ 'CollectiveConstantEntry$Value' => '

The value of a CollectiveConstantEntry.

', 'TopicConstantValue$Value' => '

The value of the TopicConstantValue.

', 'TopicConstantValue$Minimum' => '

The minimum for the TopicConstantValue.

', 'TopicConstantValue$Maximum' => '

The maximum for the TopicConstantValue.

', ], ], 'ContextMenuOption' => [ 'base' => '

The context menu options for a visual\'s interactions.

', 'refs' => [ 'VisualInteractionOptions$ContextMenuOption' => '

The context menu options for a visual.

', ], ], 'ContributionAnalysisDefault' => [ 'base' => '

The contribution analysis visual display for a line, pie, or bar chart.

', 'refs' => [ 'ContributionAnalysisDefaultList$member' => NULL, ], ], 'ContributionAnalysisDefaultList' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$ContributionAnalysisDefaults' => '

The contribution analysis (anomaly configuration) setup of the visual.

', 'LineChartConfiguration$ContributionAnalysisDefaults' => '

The default configuration of a line chart\'s contribution analysis.

', 'PieChartConfiguration$ContributionAnalysisDefaults' => '

The contribution analysis (anomaly configuration) setup of the visual.

', ], ], 'ContributionAnalysisDirection' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$Direction' => '

The direction for the TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisFactor' => [ 'base' => '

The definition for the ContributionAnalysisFactor.

', 'refs' => [ 'ContributionAnalysisFactorsList$member' => NULL, ], ], 'ContributionAnalysisFactorsList' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$Factors' => '

The factors for a TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisSortType' => [ 'base' => NULL, 'refs' => [ 'TopicIRContributionAnalysis$SortType' => '

The sort type for the TopicIRContributionAnalysis.

', ], ], 'ContributionAnalysisTimeRanges' => [ 'base' => '

The definition for the ContributionAnalysisTimeRanges.

', 'refs' => [ 'TopicIRContributionAnalysis$TimeRanges' => '

The time ranges for the TopicIRContributionAnalysis.

', ], ], 'ContributorDimensionList' => [ 'base' => NULL, 'refs' => [ 'ContributionAnalysisDefault$ContributorDimensions' => '

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers.

', ], ], 'CopySourceArn' => [ 'base' => NULL, 'refs' => [ 'DataSourceCredentials$CopySourceArn' => '

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

', ], ], 'CreateAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateColumnsOperation' => [ 'base' => '

A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.

', 'refs' => [ 'TransformOperation$CreateColumnsOperation' => '

An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

', ], ], 'CreateDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupRequest' => [ 'base' => '

The request object for this operation.

', 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => '

The response object for this operation.

', 'refs' => [], ], 'CreateIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRoleMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRoleMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicReviewedAnswer' => [ 'base' => '

The definition for a CreateTopicReviewedAnswer.

', 'refs' => [ 'CreateTopicReviewedAnswers$member' => NULL, ], ], 'CreateTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$Answers' => '

The definition of the Answers to be created.

', ], ], 'CreateVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CredentialPair' => [ 'base' => '

The combination of user name and password that are used as credentials.

', 'refs' => [ 'DataSourceCredentials$CredentialPair' => '

Credential pair. For more information, see CredentialPair .

', ], ], 'CrossDatasetTypes' => [ 'base' => NULL, 'refs' => [ 'FilterGroup$CrossDataset' => '

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

', ], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Symbol' => '

Determines the symbol for the currency format.

', ], ], 'CurrencyDisplayFormatConfiguration' => [ 'base' => '

The options that determine the currency display format configuration.

', 'refs' => [ 'NumericFormatConfiguration$CurrencyDisplayFormatConfiguration' => '

The options that determine the currency display format configuration.

', ], ], 'CustomActionColumnList' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedColumns' => '

The selected columns of a dataset.

', ], ], 'CustomActionFilterOperation' => [ 'base' => '

The filter operation that filters data included in a visual or in an entire sheet.

', 'refs' => [ 'VisualCustomActionOperation$FilterOperation' => '

The filter operation that filters data included in a visual or in an entire sheet.

', ], ], 'CustomActionNavigationOperation' => [ 'base' => '

The navigation operation that navigates between different sheets in the same analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualCustomActionOperation$NavigationOperation' => '

The navigation operation that navigates between different sheets in the same analysis.

', ], ], 'CustomActionSetParametersOperation' => [ 'base' => '

The set parameter operation that sets parameters in custom action.

', 'refs' => [ 'VisualCustomActionOperation$SetParametersOperation' => '

The set parameter operation that sets parameters in custom action.

', ], ], 'CustomActionURLOperation' => [ 'base' => '

The URL operation that opens a link to another webpage.

', 'refs' => [ 'VisualCustomActionOperation$URLOperation' => '

The URL operation that opens a link to another webpage.

', ], ], 'CustomColor' => [ 'base' => '

Determines the color that\'s applied to a particular data value in a column.

', 'refs' => [ 'CustomColorsList$member' => NULL, ], ], 'CustomColorsList' => [ 'base' => NULL, 'refs' => [ 'ColorsConfiguration$CustomColors' => '

A list of up to 50 custom colors.

', ], ], 'CustomContentConfiguration' => [ 'base' => '

The configuration of a CustomContentVisual.

', 'refs' => [ 'CustomContentVisual$ChartConfiguration' => '

The configuration of a CustomContentVisual.

', ], ], 'CustomContentImageScalingConfiguration' => [ 'base' => NULL, 'refs' => [ 'CustomContentConfiguration$ImageScaling' => '

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is \'IMAGE\'.

', ], ], 'CustomContentType' => [ 'base' => NULL, 'refs' => [ 'CustomContentConfiguration$ContentType' => '

The content type of the custom content visual. You can use this to have the visual render as an image.

', ], ], 'CustomContentVisual' => [ 'base' => '

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$CustomContentVisual' => '

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

', ], ], 'CustomFilterConfiguration' => [ 'base' => '

A custom filter that filters based on a single value. This filter can be partially matched.

', 'refs' => [ 'CategoryFilterConfiguration$CustomFilterConfiguration' => '

A custom filter that filters based on a single value. This filter can be partially matched.

', ], ], 'CustomFilterListConfiguration' => [ 'base' => '

A list of custom filter values.

', 'refs' => [ 'CategoryFilterConfiguration$CustomFilterListConfiguration' => '

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

', ], ], 'CustomLabel' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOption$CustomLabel' => '

The custom label of the pivot table field.

', 'TableFieldOption$CustomLabel' => '

The custom label for a table field.

', ], ], 'CustomNarrativeOptions' => [ 'base' => '

The custom narrative options.

', 'refs' => [ 'InsightConfiguration$CustomNarrative' => '

The custom narrative of the insight visual.

', ], ], 'CustomParameterValues' => [ 'base' => '

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomValuesConfiguration$CustomValues' => NULL, ], ], 'CustomSql' => [ 'base' => '

A physical table type built from the results of the custom SQL query.

', 'refs' => [ 'PhysicalTable$CustomSql' => '

A physical table type built from the results of the custom SQL query.

', ], ], 'CustomSqlName' => [ 'base' => NULL, 'refs' => [ 'CustomSql$Name' => '

A display name for the SQL query result.

', ], ], 'CustomValuesConfiguration' => [ 'base' => '

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

', 'refs' => [ 'DestinationParameterValueConfiguration$CustomValuesConfiguration' => '

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

', ], ], 'CustomerManagedKeyUnavailableException' => [ 'base' => '

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

', 'refs' => [], ], 'Dashboard' => [ 'base' => '

Dashboard.

', 'refs' => [ 'DescribeDashboardResponse$Dashboard' => '

Information about the dashboard.

', ], ], 'DashboardBehavior' => [ 'base' => NULL, 'refs' => [ 'AdHocFilteringOption$AvailabilityStatus' => '

Availability status.

', 'ContextMenuOption$AvailabilityStatus' => '

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

', 'DataPointDrillUpDownOption$AvailabilityStatus' => '

The status of the drill down options of data points.

', 'DataPointMenuLabelOption$AvailabilityStatus' => '

The status of the data point menu options.

', 'DataPointTooltipOption$AvailabilityStatus' => '

The status of the data point tool tip options.

', 'ExportHiddenFieldsOption$AvailabilityStatus' => '

The status of the export hidden fields options of a dashbaord.

', 'ExportToCSVOption$AvailabilityStatus' => '

Availability status.

', 'ExportWithHiddenFieldsOption$AvailabilityStatus' => '

The status of the export with hidden fields options.

', 'SheetLayoutElementMaximizationOption$AvailabilityStatus' => '

The status of the sheet layout maximization options of a dashbaord.

', 'VisualAxisSortOption$AvailabilityStatus' => '

The availaiblity status of a visual\'s axis sort options.

', 'VisualMenuOption$AvailabilityStatus' => '

The availaiblity status of a visual\'s menu options.

', ], ], 'DashboardError' => [ 'base' => '

Dashboard error.

', 'refs' => [ 'DashboardErrorList$member' => NULL, ], ], 'DashboardErrorList' => [ 'base' => NULL, 'refs' => [ 'DashboardVersion$Errors' => '

Errors associated with this dashboard version.

', 'DescribeDashboardDefinitionResponse$Errors' => '

Errors associated with this dashboard version.

', ], ], 'DashboardErrorType' => [ 'base' => NULL, 'refs' => [ 'DashboardError$Type' => '

Type.

', ], ], 'DashboardFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DashboardSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DashboardName' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$Name' => '

The display name of the dashboard.

', 'Dashboard$Name' => '

A display name for the dashboard.

', 'DashboardSummary$Name' => '

A display name for the dashboard.

', 'DescribeDashboardDefinitionResponse$Name' => '

The display name of the dashboard.

', 'UpdateDashboardRequest$Name' => '

The display name of the dashboard.

', ], ], 'DashboardPublishOptions' => [ 'base' => '

Dashboard publish options.

', 'refs' => [ 'CreateDashboardRequest$DashboardPublishOptions' => '

Options for publishing the dashboard when you create it:

', 'DescribeDashboardDefinitionResponse$DashboardPublishOptions' => '

Options for publishing the dashboard:

', 'UpdateDashboardRequest$DashboardPublishOptions' => '

Options for publishing the dashboard when you create it:

', ], ], 'DashboardSearchFilter' => [ 'base' => '

A filter that you apply when searching for dashboards.

', 'refs' => [ 'DashboardSearchFilterList$member' => NULL, ], ], 'DashboardSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDashboardsRequest$Filters' => '

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

', ], ], 'DashboardSourceEntity' => [ 'base' => '

Dashboard source entity.

', 'refs' => [ 'CreateDashboardRequest$SourceEntity' => '

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 SourceTemplateARN 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.

', 'UpdateDashboardRequest$SourceEntity' => '

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.

', ], ], 'DashboardSourceTemplate' => [ 'base' => '

Dashboard source template.

', 'refs' => [ 'DashboardSourceEntity$SourceTemplate' => '

Source template.

', ], ], 'DashboardSummary' => [ 'base' => '

Dashboard summary.

', 'refs' => [ 'DashboardSummaryList$member' => NULL, ], ], 'DashboardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDashboardsResponse$DashboardSummaryList' => '

A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

', 'SearchDashboardsResponse$DashboardSummaryList' => '

The list of dashboards owned by the user specified in Filters in your request.

', ], ], 'DashboardUIState' => [ 'base' => NULL, 'refs' => [ 'SheetControlsOption$VisibilityState' => '

Visibility state.

', ], ], 'DashboardVersion' => [ 'base' => '

Dashboard version.

', 'refs' => [ 'Dashboard$Version' => '

Version.

', ], ], 'DashboardVersionDefinition' => [ 'base' => '

The contents of a dashboard.

', 'refs' => [ 'CreateDashboardRequest$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeDashboardDefinitionResponse$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateDashboardRequest$Definition' => '

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'DashboardVersionSummary' => [ 'base' => '

Dashboard version summary.

', 'refs' => [ 'DashboardVersionSummaryList$member' => NULL, ], ], 'DashboardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDashboardVersionsResponse$DashboardVersionSummaryList' => '

A structure that contains information about each version of the dashboard.

', ], ], 'DashboardVisualId' => [ 'base' => '

A structure that contains the following elements:

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.

', 'refs' => [ 'AnonymousUserDashboardVisualEmbeddingConfiguration$InitialDashboardVisualId' => '

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.

', 'RegisteredUserDashboardVisualEmbeddingConfiguration$InitialDashboardVisualId' => '

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.

', ], ], 'DashboardVisualPublishOptions' => [ 'base' => '

The visual publish options of a visual in a dashboard

', 'refs' => [ 'DashboardPublishOptions$VisualPublishOptions' => '

The visual publish options of a visual in a dashboard.

', ], ], 'DataAggregation' => [ 'base' => '

A structure that represents a data aggregation.

', 'refs' => [ 'DatasetMetadata$DataAggregation' => '

The definition of a data aggregation.

', ], ], 'DataBarsOptions' => [ 'base' => '

The options for data bars.

', 'refs' => [ 'TableInlineVisualization$DataBars' => '

The configuration of the inline visualization of the data bars within a chart.

', ], ], 'DataColor' => [ 'base' => '

Determines the color that is applied to a particular data value.

', 'refs' => [ 'ColorScale$NullValueColor' => '

Determines the color that is applied to null values.

', 'ColorScaleColorList$member' => NULL, ], ], 'DataColorPalette' => [ 'base' => '

The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

', 'refs' => [ 'ThemeConfiguration$DataColorPalette' => '

Color properties that apply to chart data colors.

', ], ], 'DataFieldSeriesItem' => [ 'base' => '

The data field series item configuration of a line chart.

', 'refs' => [ 'SeriesItem$DataFieldSeriesItem' => '

The data field series item configuration of a line chart.

', ], ], 'DataLabelContent' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$LabelContent' => '

Determines the content of the data labels.

', ], ], 'DataLabelOptions' => [ 'base' => '

The options that determine the presentation of the data labels.

', 'refs' => [ 'BarChartConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'ComboChartConfiguration$BarDataLabels' => '

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

', 'ComboChartConfiguration$LineDataLabels' => '

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

', 'GaugeChartConfiguration$DataLabels' => '

The data label configuration of a GaugeChartVisual.

', 'HeatMapConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'HistogramConfiguration$DataLabels' => '

The data label configuration of a histogram.

', 'LineChartConfiguration$DataLabels' => '

The data label configuration of a line chart.

', 'PieChartConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'SankeyDiagramChartConfiguration$DataLabels' => '

The data label configuration of a sankey diagram.

', 'ScatterPlotConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'TreeMapConfiguration$DataLabels' => '

The options that determine if visual data labels are displayed.

', 'WaterfallChartConfiguration$DataLabels' => '

The data label configuration of a waterfall visual.

', ], ], 'DataLabelOverlap' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$Overlap' => '

Determines whether overlap is enabled or disabled for the data labels.

', ], ], 'DataLabelPosition' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$Position' => '

Determines the position of the data labels.

', 'FunnelChartDataLabelOptions$Position' => '

Determines the positioning of the data label relative to a section of the funnel.

', ], ], 'DataLabelType' => [ 'base' => '

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DataLabelTypes$member' => NULL, ], ], 'DataLabelTypes' => [ 'base' => NULL, 'refs' => [ 'DataLabelOptions$DataLabelTypes' => '

The option that determines the data label type.

', ], ], 'DataPathColor' => [ 'base' => '

The color map that determines the color options for a particular element.

', 'refs' => [ 'DataPathColorList$member' => NULL, ], ], 'DataPathColorList' => [ 'base' => NULL, 'refs' => [ 'VisualPalette$ColorMap' => '

The color map options for the visual palette.

', ], ], 'DataPathLabelType' => [ 'base' => '

The option that specifies individual data values for labels.

', 'refs' => [ 'DataLabelType$DataPathLabelType' => '

The option that specifies individual data values for labels.

', ], ], 'DataPathSort' => [ 'base' => '

Allows data paths to be sorted by a specific data value.

', 'refs' => [ 'PivotTableSortBy$DataPath' => '

The data path sort (data path value, direction) for the pivot table sort by options.

', ], ], 'DataPathType' => [ 'base' => '

The type of the data path value.

', 'refs' => [ 'DataPathValue$DataPathType' => '

The type configuration of the field.

', ], ], 'DataPathValue' => [ 'base' => '

The data path that needs to be sorted.

', 'refs' => [ 'DataPathColor$Element' => '

The element that the color needs to be applied to.

', 'DataPathValueList$member' => NULL, ], ], 'DataPathValueList' => [ 'base' => NULL, 'refs' => [ 'DataPathSort$SortPaths' => '

The list of data paths that need to be sorted.

', 'PivotTableDataPathOption$DataPathList' => '

The list of data path values for the data path options.

', 'PivotTableFieldCollapseStateTarget$FieldDataPathValues' => '

The data path of the pivot table\'s header. Used to set the collapse state.

', ], ], 'DataPointDrillUpDownOption' => [ 'base' => '

The drill down options for data points in a dashbaord.

', 'refs' => [ 'DashboardPublishOptions$DataPointDrillUpDownOption' => '

The drill-down options of data points in a dashboard.

', ], ], 'DataPointMenuLabelOption' => [ 'base' => '

The data point menu options of a dashboard.

', 'refs' => [ 'DashboardPublishOptions$DataPointMenuLabelOption' => '

The data point menu label options of a dashboard.

', ], ], 'DataPointTooltipOption' => [ 'base' => '

The data point tooltip options.

', 'refs' => [ 'DashboardPublishOptions$DataPointTooltipOption' => '

The data point tool tip options of a dashboard.

', ], ], 'DataSet' => [ 'base' => '

Dataset.

', 'refs' => [ 'DescribeDataSetResponse$DataSet' => '

Information on the dataset.

', ], ], 'DataSetArnsList' => [ 'base' => NULL, 'refs' => [ 'Analysis$DataSetArns' => '

The ARNs of the datasets of the analysis.

', 'DashboardVersion$DataSetArns' => '

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

', ], ], 'DataSetCalculatedFieldExpression' => [ 'base' => NULL, 'refs' => [ 'CalculatedColumn$Expression' => '

An expression that defines the calculated column.

', ], ], 'DataSetConfiguration' => [ 'base' => '

Dataset configuration.

', 'refs' => [ 'DataSetConfigurationList$member' => NULL, ], ], 'DataSetConfigurationList' => [ 'base' => NULL, 'refs' => [ 'TemplateVersion$DataSetConfigurations' => '

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

', 'TemplateVersionDefinition$DataSetConfigurations' => '

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

', ], ], 'DataSetFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DataSetSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DataSetIdentifier' => [ 'base' => NULL, 'refs' => [ 'CalculatedField$DataSetIdentifier' => '

The data set that is used in this calculated field.

', 'ColumnIdentifier$DataSetIdentifier' => '

The data set that the column belongs to.

', 'CustomContentVisual$DataSetIdentifier' => '

The dataset that is used to create the custom content visual. You can\'t create a visual without a dataset.

', 'DataSetIdentifierDeclaration$Identifier' => '

The identifier of the data set, typically the data set\'s name.

', 'EmptyVisual$DataSetIdentifier' => '

The data set that is used in the empty visual. Every visual requires a dataset to render.

', 'InsightVisual$DataSetIdentifier' => '

The dataset that is used in the insight visual.

', 'MappedDataSetParameter$DataSetIdentifier' => '

A unique name that identifies a dataset within the analysis or dashboard.

', 'RollingDateConfiguration$DataSetIdentifier' => '

The data set that is used in the rolling date configuration.

', ], ], 'DataSetIdentifierDeclaration' => [ 'base' => '

A data set.

', 'refs' => [ 'DataSetIdentifierDeclarationList$member' => NULL, ], ], 'DataSetIdentifierDeclarationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$DataSetIdentifierDeclarations' => '

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

', 'DashboardVersionDefinition$DataSetIdentifierDeclarations' => '

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard\'s sub-structures.

', ], ], 'DataSetImportMode' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$ImportMode' => '

Indicates whether you want to import the data into SPICE.

', 'DataSet$ImportMode' => '

A value that indicates whether you want to import the data into SPICE.

', 'DataSetSummary$ImportMode' => '

A value that indicates whether you want to import the data into SPICE.

', 'UpdateDataSetRequest$ImportMode' => '

Indicates whether you want to import the data into SPICE.

', ], ], 'DataSetName' => [ 'base' => NULL, 'refs' => [ 'AwsIotAnalyticsParameters$DataSetName' => '

Dataset name.

', ], ], 'DataSetReference' => [ 'base' => '

Dataset reference.

', 'refs' => [ 'DataSetReferenceList$member' => NULL, ], ], 'DataSetReferenceList' => [ 'base' => NULL, 'refs' => [ 'AnalysisSourceTemplate$DataSetReferences' => '

The dataset references of the source template of an analysis.

', 'DashboardSourceTemplate$DataSetReferences' => '

Dataset references.

', 'TemplateSourceAnalysis$DataSetReferences' => '

A structure containing information about the dataset references used as placeholders in the template.

', ], ], 'DataSetRefreshProperties' => [ 'base' => '

The refresh properties of a dataset.

', 'refs' => [ 'DescribeDataSetRefreshPropertiesResponse$DataSetRefreshProperties' => '

The dataset refresh properties.

', 'PutDataSetRefreshPropertiesRequest$DataSetRefreshProperties' => '

The dataset refresh properties.

', ], ], 'DataSetRegion' => [ 'base' => NULL, 'refs' => [ 'BigQueryParameters$DataSetRegion' => '

The storage location where you create a Google BigQuery data source.

', ], ], 'DataSetSchema' => [ 'base' => '

Dataset schema.

', 'refs' => [ 'DataSetConfiguration$DataSetSchema' => '

Dataset schema.

', ], ], 'DataSetSearchFilter' => [ 'base' => '

A filter that you apply when searching for datasets.

', 'refs' => [ 'DataSetSearchFilterList$member' => NULL, ], ], 'DataSetSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSetsRequest$Filters' => '

The filters to apply to the search.

', ], ], 'DataSetSummary' => [ 'base' => '

Dataset summary.

', 'refs' => [ 'DataSetSummaryList$member' => NULL, ], ], 'DataSetSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataSetsResponse$DataSetSummaries' => '

The list of dataset summaries.

', 'SearchDataSetsResponse$DataSetSummaries' => '

A DataSetSummaries object that returns a summary of a dataset.

', ], ], 'DataSetUsageConfiguration' => [ 'base' => '

The usage configuration to apply to child datasets that reference this dataset as a source.

', 'refs' => [ 'CreateDataSetRequest$DataSetUsageConfiguration' => NULL, 'DataSet$DataSetUsageConfiguration' => '

The usage configuration to apply to child datasets that reference this dataset as a source.

', 'UpdateDataSetRequest$DataSetUsageConfiguration' => NULL, ], ], 'DataSource' => [ 'base' => '

The structure of a data source.

', 'refs' => [ 'DataSourceList$member' => NULL, 'DescribeDataSourceResponse$DataSource' => '

The information on the data source.

', ], ], 'DataSourceCredentials' => [ 'base' => '

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'CreateDataSourceRequest$Credentials' => '

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

', 'UpdateDataSourceRequest$Credentials' => '

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

', ], ], 'DataSourceErrorInfo' => [ 'base' => '

Error information for the data source creation or update.

', 'refs' => [ 'DataSource$ErrorInfo' => '

Error information from the last update or the creation of the data source.

', ], ], 'DataSourceErrorInfoType' => [ 'base' => NULL, 'refs' => [ 'DataSourceErrorInfo$Type' => '

Error type.

', ], ], 'DataSourceFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DataSourceSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources.

', ], ], 'DataSourceParameters' => [ 'base' => '

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.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$DataSourceParameters' => NULL, 'CreateDataSourceRequest$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source.

', 'DataSource$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'DataSourceParametersList$member' => NULL, 'UpdateDataSourceRequest$DataSourceParameters' => '

The parameters that Amazon QuickSight uses to connect to your underlying source.

', ], ], 'DataSourceParametersList' => [ 'base' => NULL, 'refs' => [ 'CredentialPair$AlternateDataSourceParameters' => '

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that\'s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

', 'DataSource$AlternateDataSourceParameters' => '

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that\'s in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

', ], ], 'DataSourceSearchFilter' => [ 'base' => '

A filter that you apply when searching for data sources.

', 'refs' => [ 'DataSourceSearchFilterList$member' => NULL, ], ], 'DataSourceSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSourcesRequest$Filters' => '

The filters to apply to the search.

', ], ], 'DataSourceSummary' => [ 'base' => '

A DataSourceSummary object that returns a summary of a data source.

', 'refs' => [ 'DataSourceSummaryList$member' => NULL, ], ], 'DataSourceSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchDataSourcesResponse$DataSourceSummaries' => '

A DataSourceSummaries object that returns a summary of a data source.

', ], ], 'DataSourceType' => [ 'base' => NULL, 'refs' => [ 'CreateDataSourceRequest$Type' => '

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

', 'DataSource$Type' => '

The type of the data source. This type indicates which database engine the data source connects to.

', 'DataSourceSummary$Type' => '

The type of the data source.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Database' => '

Database.

', 'AuroraPostgreSqlParameters$Database' => '

The Amazon Aurora PostgreSQL database to connect to.

', 'MariaDbParameters$Database' => '

Database.

', 'MySqlParameters$Database' => '

Database.

', 'OracleParameters$Database' => '

The database.

', 'PostgreSqlParameters$Database' => '

Database.

', 'RdsParameters$Database' => '

Database.

', 'RedshiftParameters$Database' => '

Database.

', 'SnowflakeParameters$Database' => '

Database.

', 'SqlServerParameters$Database' => '

Database.

', 'TeradataParameters$Database' => '

Database.

', ], ], 'DatabaseGroup' => [ 'base' => NULL, 'refs' => [ 'DatabaseGroupList$member' => NULL, ], ], 'DatabaseGroupList' => [ 'base' => NULL, 'refs' => [ 'RedshiftIAMParameters$DatabaseGroups' => '

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.

', ], ], 'DatabaseUser' => [ 'base' => NULL, 'refs' => [ 'RedshiftIAMParameters$DatabaseUser' => '

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.

', ], ], 'DatabricksParameters' => [ 'base' => '

The parameters that are required to connect to a Databricks data source.

', 'refs' => [ 'DataSourceParameters$DatabricksParameters' => '

The parameters that are required to connect to a Databricks data source.

', ], ], 'DatasetMetadata' => [ 'base' => '

A structure that represents a dataset.

', 'refs' => [ 'Datasets$member' => NULL, ], ], 'DatasetParameter' => [ 'base' => '

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

', 'refs' => [ 'DatasetParameterList$member' => NULL, ], ], 'DatasetParameterId' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameter$Id' => '

An identifier for the parameter that is created in the dataset.

', 'DecimalDatasetParameter$Id' => '

An identifier for the decimal parameter created in the dataset.

', 'IntegerDatasetParameter$Id' => '

An identifier for the integer parameter created in the dataset.

', 'StringDatasetParameter$Id' => '

An identifier for the string parameter that is created in the dataset.

', ], ], 'DatasetParameterList' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$DatasetParameters' => '

The parameter declarations of the dataset.

', 'DataSet$DatasetParameters' => '

The parameters that are declared in a dataset.

', 'UpdateDataSetRequest$DatasetParameters' => '

The parameter declarations of the dataset.

', ], ], 'DatasetParameterName' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameter$Name' => '

The name of the date time parameter that is created in the dataset.

', 'DecimalDatasetParameter$Name' => '

The name of the decimal parameter that is created in the dataset.

', 'IntegerDatasetParameter$Name' => '

The name of the integer parameter that is created in the dataset.

', 'OverrideDatasetParameterOperation$ParameterName' => '

The name of the parameter to be overridden with different values.

', 'OverrideDatasetParameterOperation$NewParameterName' => '

The new name for the parameter.

', 'StringDatasetParameter$Name' => '

The name of the string parameter that is created in the dataset.

', ], ], 'DatasetParameterValueType' => [ 'base' => '

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

', 'refs' => [ 'DateTimeDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'DecimalDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'IntegerDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', 'StringDatasetParameter$ValueType' => '

The value type of the dataset parameter. Valid values are single value or multi value.

', ], ], 'Datasets' => [ 'base' => NULL, 'refs' => [ 'TopicDetails$DataSets' => '

The data sets that the topic is associated with.

', ], ], 'DateAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AggregationFunction$DateAggregationFunction' => '

Aggregation for date values.

', 'DateMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', ], ], 'DateAxisOptions' => [ 'base' => '

The options that determine how a date axis is displayed.

', 'refs' => [ 'AxisDataOptions$DateAxisOptions' => '

The options for an axis with a date field.

', ], ], 'DateDimensionField' => [ 'base' => '

The dimension type field with date type columns.

', 'refs' => [ 'DimensionField$DateDimensionField' => '

The dimension type field with date type columns.

', ], ], 'DateMeasureField' => [ 'base' => '

The measure type field with date type columns.

', 'refs' => [ 'MeasureField$DateMeasureField' => '

The measure type field with date type columns.

', ], ], 'DateTimeDatasetParameter' => [ 'base' => '

A date time parameter for a dataset.

', 'refs' => [ 'DatasetParameter$DateTimeDatasetParameter' => '

A date time parameter that is created in the dataset.

', ], ], 'DateTimeDatasetParameterDefaultValue' => [ 'base' => '

The default value for the date time parameter.

', 'refs' => [ 'DateTimeDatasetParameterValueList$member' => NULL, ], ], 'DateTimeDatasetParameterDefaultValues' => [ 'base' => '

The default values of a date time parameter.

', 'refs' => [ 'DateTimeDatasetParameter$DefaultValues' => '

A list of default values for a given date time parameter. This structure only accepts static values.

', ], ], 'DateTimeDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'DateTimeDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given date time parameter.

', 'NewDefaultValues$DateTimeStaticValues' => '

A list of static default values for a given date time parameter.

', ], ], 'DateTimeDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$DateTimeValues' => '

A list of datetime-type parameter values.

', 'DateTimeDefaultValues$StaticValues' => '

The static values of the DataTimeDefaultValues.

', ], ], 'DateTimeDefaultValues' => [ 'base' => '

The default values of the DateTimeParameterDeclaration.

', 'refs' => [ 'DateTimeParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'DateTimeFormat' => [ 'base' => NULL, 'refs' => [ 'DateTimeFormatConfiguration$DateTimeFormat' => '

Determines the DateTime format.

', 'DateTimePickerControlDisplayOptions$DateTimeFormat' => '

Customize how dates are formatted in controls.

', 'RelativeDateTimeControlDisplayOptions$DateTimeFormat' => '

Customize how dates are formatted in controls.

', ], ], 'DateTimeFormatConfiguration' => [ 'base' => '

Formatting configuration for DateTime fields.

', 'refs' => [ 'DateDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'DateMeasureField$FormatConfiguration' => '

The format configuration of the field.

', 'FormatConfiguration$DateTimeFormatConfiguration' => '

Formatting configuration for DateTime fields.

', ], ], 'DateTimeHierarchy' => [ 'base' => '

The option that determines the hierarchy of any DateTime fields.

', 'refs' => [ 'ColumnHierarchy$DateTimeHierarchy' => '

The option that determines the hierarchy of any DateTime fields.

', ], ], 'DateTimeParameter' => [ 'base' => '

A date-time parameter.

', 'refs' => [ 'DateTimeParameterList$member' => NULL, ], ], 'DateTimeParameterDeclaration' => [ 'base' => '

A parameter declaration for the DateTime data type.

', 'refs' => [ 'ParameterDeclaration$DateTimeParameterDeclaration' => '

A parameter declaration for the DateTime data type.

', ], ], 'DateTimeParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$DateTimeParameters' => '

The parameters that have a data type of date-time.

', ], ], 'DateTimePickerControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultDateTimePickerControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterDateTimePickerControl$DisplayOptions' => '

The display options of a control.

', 'ParameterDateTimePickerControl$DisplayOptions' => '

The display options of a control.

', ], ], 'DateTimeValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a DateTime parameter when a value has not been set.

', 'refs' => [ 'DateTimeParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a DateTime parameter when a value has not been set.

', ], ], 'DayOfMonth' => [ 'base' => NULL, 'refs' => [ 'ScheduleRefreshOnEntity$DayOfMonth' => '

The day of the month that you want to schedule refresh on.

', ], ], 'DayOfTheWeek' => [ 'base' => NULL, 'refs' => [ 'AssetOptions$WeekStart' => '

Determines the week start day for an analysis.

', ], ], 'DayOfWeek' => [ 'base' => NULL, 'refs' => [ 'ScheduleRefreshOnEntity$DayOfWeek' => '

The day of the week that you want to schedule a refresh on.

', ], ], 'DbUsername' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentialPair$Username' => '

The username for the data source connection.

', 'CredentialPair$Username' => '

User name.

', ], ], 'DecimalDatasetParameter' => [ 'base' => '

A decimal parameter for a dataset.

', 'refs' => [ 'DatasetParameter$DecimalDatasetParameter' => '

A decimal parameter that is created in the dataset.

', ], ], 'DecimalDatasetParameterDefaultValue' => [ 'base' => '

The default value for the decimal parameter.

', 'refs' => [ 'DecimalDatasetParameterValueList$member' => NULL, ], ], 'DecimalDatasetParameterDefaultValues' => [ 'base' => '

The default values of a decimal parameter.

', 'refs' => [ 'DecimalDatasetParameter$DefaultValues' => '

A list of default values for a given decimal parameter. This structure only accepts static values.

', ], ], 'DecimalDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'DecimalDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given decimal parameter.

', 'NewDefaultValues$DecimalStaticValues' => '

A list of static default values for a given decimal parameter.

', ], ], 'DecimalDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$DecimalValues' => '

A list of decimal-type parameter values.

', 'DecimalDefaultValues$StaticValues' => '

The static values of the DecimalDefaultValues.

', ], ], 'DecimalDefaultValues' => [ 'base' => '

The default values of the DecimalParameterDeclaration.

', 'refs' => [ 'DecimalParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'DecimalParameter' => [ 'base' => '

A decimal parameter.

', 'refs' => [ 'DecimalParameterList$member' => NULL, ], ], 'DecimalParameterDeclaration' => [ 'base' => '

A parameter declaration for the Decimal data type.

', 'refs' => [ 'ParameterDeclaration$DecimalParameterDeclaration' => '

A parameter declaration for the Decimal data type.

', ], ], 'DecimalParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$DecimalParameters' => '

The parameters that have a data type of decimal.

', ], ], 'DecimalPlaces' => [ 'base' => NULL, 'refs' => [ 'DecimalPlacesConfiguration$DecimalPlaces' => '

The values of the decimal places.

', ], ], 'DecimalPlacesConfiguration' => [ 'base' => '

The option that determines the decimal places configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', 'NumberDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', 'PercentageDisplayFormatConfiguration$DecimalPlacesConfiguration' => '

The option that determines the decimal places configuration.

', ], ], 'DecimalValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a Decimal parameter when a value has not been set.

', 'refs' => [ 'DecimalParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a Decimal parameter when a value has not been set.

', ], ], 'DefaultAggregation' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$Aggregation' => '

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

', 'TopicColumn$Aggregation' => '

The type of aggregation that is performed on the column data when it\'s queried.

', ], ], 'DefaultDateTimePickerControlOptions' => [ 'base' => '

The default options that correspond to the filter control type of a DateTimePicker.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultDateTimePickerOptions' => '

The default options that correspond to the filter control type of a DateTimePicker.

', ], ], 'DefaultFilterControlConfiguration' => [ 'base' => '

The default configuration for all dependent controls of the filter.

', 'refs' => [ 'CategoryFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'CategoryInnerFilter$DefaultFilterControlConfiguration' => NULL, 'NumericEqualityFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'NumericRangeFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'RelativeDatesFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TimeEqualityFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TimeRangeFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', 'TopBottomFilter$DefaultFilterControlConfiguration' => '

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

', ], ], 'DefaultFilterControlOptions' => [ 'base' => '

The option that corresponds to the control type of the filter.

', 'refs' => [ 'DefaultFilterControlConfiguration$ControlOptions' => '

The control option for the DefaultFilterControlConfiguration.

', ], ], 'DefaultFilterDropDownControlOptions' => [ 'base' => '

The default options that correspond to the Dropdown filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultDropdownOptions' => '

The default options that correspond to the Dropdown filter control type.

', ], ], 'DefaultFilterListControlOptions' => [ 'base' => '

The default options that correspond to the List filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultListOptions' => '

The default options that correspond to the List filter control type.

', ], ], 'DefaultFormatting' => [ 'base' => '

A structure that represents a default formatting definition.

', 'refs' => [ 'TopicCalculatedField$DefaultFormatting' => '

The default formatting definition.

', 'TopicColumn$DefaultFormatting' => '

The default formatting used for values in the column.

', ], ], 'DefaultFreeFormLayoutConfiguration' => [ 'base' => '

The options that determine the default settings of a free-form layout configuration.

', 'refs' => [ 'DefaultInteractiveLayoutConfiguration$FreeForm' => '

The options that determine the default settings of a free-form layout configuration.

', ], ], 'DefaultGridLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a grid layout configuration.

', 'refs' => [ 'DefaultInteractiveLayoutConfiguration$Grid' => '

The options that determine the default settings for a grid layout configuration.

', ], ], 'DefaultInteractiveLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for interactive layout configuration.

', 'refs' => [ 'DefaultNewSheetConfiguration$InteractiveLayoutConfiguration' => '

The options that determine the default settings for interactive layout configuration.

', ], ], 'DefaultNewSheetConfiguration' => [ 'base' => '

The configuration for default new sheet settings.

', 'refs' => [ 'AnalysisDefaults$DefaultNewSheetConfiguration' => '

The configuration for default new sheet settings.

', ], ], 'DefaultPaginatedLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a paginated layout configuration.

', 'refs' => [ 'DefaultNewSheetConfiguration$PaginatedLayoutConfiguration' => '

The options that determine the default settings for a paginated layout configuration.

', ], ], 'DefaultRelativeDateTimeControlOptions' => [ 'base' => '

The default options that correspond to the RelativeDateTime filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultRelativeDateTimeOptions' => '

The default options that correspond to the RelativeDateTime filter control type.

', ], ], 'DefaultSectionBasedLayoutConfiguration' => [ 'base' => '

The options that determine the default settings for a section-based layout configuration.

', 'refs' => [ 'DefaultPaginatedLayoutConfiguration$SectionBased' => '

The options that determine the default settings for a section-based layout configuration.

', ], ], 'DefaultSliderControlOptions' => [ 'base' => '

The default options that correspond to the Slider filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultSliderOptions' => '

The default options that correspond to the Slider filter control type.

', ], ], 'DefaultTextAreaControlOptions' => [ 'base' => '

The default options that correspond to the TextArea filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultTextAreaOptions' => '

The default options that correspond to the TextArea filter control type.

', ], ], 'DefaultTextFieldControlOptions' => [ 'base' => '

The default options that correspond to the TextField filter control type.

', 'refs' => [ 'DefaultFilterControlOptions$DefaultTextFieldOptions' => '

The default options that correspond to the TextField filter control type.

', ], ], 'DeleteAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityPropagationConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIdentityPropagationConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoleMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserByPrincipalIdRequest' => [ 'base' => '

', 'refs' => [], ], 'DeleteUserByPrincipalIdResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Delimiter' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$Delimiter' => '

The delimiter between values in the file.

', ], ], 'DescribeAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountSubscriptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAssetBundleImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDashboardSnapshotJobResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourcePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourcePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResolvedPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResolvedPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIpRestrictionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeIpRestrictionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeyRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeKeyRegistrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplatePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplatePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationParameterValueConfiguration' => [ 'base' => '

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'SetParameterValueConfiguration$Value' => NULL, ], ], 'DimensionField' => [ 'base' => '

The dimension type field.

', 'refs' => [ 'BoxPlotDimensionFieldList$member' => NULL, 'DimensionFieldList$member' => NULL, 'FilledMapDimensionFieldList$member' => NULL, 'ForecastComputation$Time' => '

The time field that is used in a computation.

', 'FunnelChartDimensionFieldList$member' => NULL, 'GrowthRateComputation$Time' => '

The time field that is used in a computation.

', 'HeatMapDimensionFieldList$member' => NULL, 'MaximumMinimumComputation$Time' => '

The time field that is used in a computation.

', 'MetricComparisonComputation$Time' => '

The time field that is used in a computation.

', 'PeriodOverPeriodComputation$Time' => '

The time field that is used in a computation.

', 'PeriodToDateComputation$Time' => '

The time field that is used in a computation.

', 'PivotTableDimensionList$member' => NULL, 'RadarChartCategoryFieldList$member' => NULL, 'RadarChartColorFieldList$member' => NULL, 'SmallMultiplesDimensionFieldList$member' => NULL, 'TopBottomMoversComputation$Time' => '

The time field that is used in a computation.

', 'TopBottomMoversComputation$Category' => '

The category field that is used in a computation.

', 'TopBottomRankedComputation$Category' => '

The category field that is used in a computation.

', 'TreeMapDimensionFieldList$member' => NULL, 'UniqueValuesComputation$Category' => '

The category field that is used in a computation.

', 'WordCloudDimensionFieldList$member' => NULL, ], ], 'DimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$Category' => '

The category (y-axis) field well of a bar chart.

', 'BarChartAggregatedFieldWells$Colors' => '

The color (group/color) field well of a bar chart.

', 'ComboChartAggregatedFieldWells$Category' => '

The aggregated category field wells of a combo chart.

', 'ComboChartAggregatedFieldWells$Colors' => '

The aggregated colors field well of a combo chart.

', 'GeospatialMapAggregatedFieldWells$Geospatial' => '

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

', 'GeospatialMapAggregatedFieldWells$Colors' => '

The color field wells of a geospatial map.

', 'KPIFieldWells$TrendGroups' => '

The trend group field wells of a KPI visual.

', 'LineChartAggregatedFieldWells$Category' => '

The category field wells of a line chart. Values are grouped by category fields.

', 'LineChartAggregatedFieldWells$Colors' => '

The color field wells of a line chart. Values are grouped by category fields.

', 'PieChartAggregatedFieldWells$Category' => '

The category (group/color) field wells of a pie chart.

', 'SankeyDiagramAggregatedFieldWells$Source' => '

The source field wells of a sankey diagram.

', 'SankeyDiagramAggregatedFieldWells$Destination' => '

The destination field wells of a sankey diagram.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Category' => '

The category field well of a scatter plot.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Label' => '

The label field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$XAxis' => '

The x-axis field well of a scatter plot.

The x-axis is a dimension field and cannot be aggregated.

', 'ScatterPlotUnaggregatedFieldWells$YAxis' => '

The y-axis field well of a scatter plot.

The y-axis is a dimension field and cannot be aggregated.

', 'ScatterPlotUnaggregatedFieldWells$Category' => '

The category field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$Label' => '

The label field well of a scatter plot.

', 'TableAggregatedFieldWells$GroupBy' => '

The group by field well for a pivot table. Values are grouped by group by fields.

', 'WaterfallChartAggregatedFieldWells$Categories' => '

The category field wells of a waterfall visual.

', 'WaterfallChartAggregatedFieldWells$Breakdowns' => '

The breakdown field wells of a waterfall visual.

', ], ], 'DisplayFormat' => [ 'base' => NULL, 'refs' => [ 'DefaultFormatting$DisplayFormat' => '

The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.

', 'TopicIRGroupBy$DisplayFormat' => '

The display format for the TopicIRGroupBy.

', 'TopicIRMetric$DisplayFormat' => '

The display format for the TopicIRMetric.

', ], ], 'DisplayFormatOptions' => [ 'base' => '

A structure that represents additional options for display formatting.

', 'refs' => [ 'DefaultFormatting$DisplayFormatOptions' => '

The additional options for display formatting.

', 'TopicIRGroupBy$DisplayFormatOptions' => NULL, 'TopicIRMetric$DisplayFormatOptions' => NULL, ], ], 'DnsResolverList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$DnsResolvers' => '

An optional override of DNS resolvers to be used by the VPC connection.

', 'CreateVPCConnectionRequest$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', 'UpdateVPCConnectionRequest$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'AmazonElasticsearchParameters$Domain' => '

The OpenSearch domain.

', 'AmazonOpenSearchParameters$Domain' => '

The OpenSearch domain.

', ], ], 'DomainNotWhitelistedException' => [ 'base' => '

The domain specified isn\'t on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.

', 'refs' => [], ], 'DonutCenterOptions' => [ 'base' => '

The label options of the label that is displayed in the center of a donut chart. This option isn\'t available for pie charts.

', 'refs' => [ 'DonutOptions$DonutCenterOptions' => '

The label options of the label that is displayed in the center of a donut chart. This option isn\'t available for pie charts.

', ], ], 'DonutOptions' => [ 'base' => '

The options for configuring a donut chart or pie chart.

', 'refs' => [ 'PieChartConfiguration$DonutOptions' => '

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'ArcAxisDisplayRange$Min' => '

The minimum value of the arc axis range.

', 'ArcAxisDisplayRange$Max' => '

The maximum value of the arc axis range.

', 'ArcConfiguration$ArcAngle' => '

The option that determines the arc angle of a GaugeChartVisual.

', 'AxisDisplayMinMaxRange$Minimum' => '

The minimum setup for an axis display range.

', 'AxisDisplayMinMaxRange$Maximum' => '

The maximum setup for an axis display range.

', 'AxisLinearScale$StepSize' => '

The step size setup of a linear axis.

', 'AxisLogarithmicScale$Base' => '

The base setup of a logarithmic axis scale.

', 'AxisTickLabelOptions$RotationAngle' => '

The rotation angle of the axis tick labels.

', 'DataColor$DataValue' => '

The data value that the color is applied to.

', 'DefaultSliderControlOptions$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'DefaultSliderControlOptions$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'DefaultSliderControlOptions$StepSize' => '

The number of increments that the slider bar is divided into.

', 'FilterSliderControl$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'FilterSliderControl$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'FilterSliderControl$StepSize' => '

The number of increments that the slider bar is divided into.

', 'ForecastComputation$UpperBoundary' => '

The upper boundary setup of a forecast computation.

', 'ForecastComputation$LowerBoundary' => '

The lower boundary setup of a forecast computation.

', 'GradientStop$GradientOffset' => '

Determines gradient offset value.

', 'GradientStop$DataValue' => '

Determines the data value.

', 'HistogramBinOptions$StartValue' => '

The options that determine the bin start value.

', 'NumericEqualityDrillDownFilter$Value' => '

The value of the double input numeric drill down filter.

', 'NumericEqualityFilter$Value' => '

The input value.

', 'NumericRangeFilterValue$StaticValue' => '

The static value of the numeric range filter.

', 'ParameterSliderControl$MaximumValue' => '

The larger value that is displayed at the right of the slider.

', 'ParameterSliderControl$MinimumValue' => '

The smaller value that is displayed at the left of the slider.

', 'ParameterSliderControl$StepSize' => '

The number of increments that the slider bar is divided into.

', 'TimeBasedForecastProperties$UpperBoundary' => '

The upper boundary setup of a forecast computation.

', 'TimeBasedForecastProperties$LowerBoundary' => '

The lower boundary setup of a forecast computation.

', 'WhatIfPointScenario$Value' => '

The target value that you want to meet for the provided date.

', 'WhatIfRangeScenario$Value' => '

The target value that you want to meet for the provided date range.

', ], ], 'DrillDownFilter' => [ 'base' => '

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DrillDownFilterList$member' => NULL, ], ], 'DrillDownFilterList' => [ 'base' => NULL, 'refs' => [ 'DateTimeHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the DateTime hierarchy.

', 'ExplicitHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the explicit hierarchy.

', 'PredefinedHierarchy$DrillDownFilters' => '

The option that determines the drill down filters for the predefined hierarchy.

', ], ], 'DropDownControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultFilterDropDownControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterDropDownControl$DisplayOptions' => '

The display options of the FilterDropDownControl.

', 'ParameterDropDownControl$DisplayOptions' => '

The display options of a control.

', ], ], 'DynamicDefaultValue' => [ 'base' => '

Defines different defaults to the users or groups based on mapping.

', 'refs' => [ 'DateTimeDefaultValues$DynamicValue' => '

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'DecimalDefaultValues$DynamicValue' => '

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'IntegerDefaultValues$DynamicValue' => '

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

', 'StringDefaultValues$DynamicValue' => '

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

', ], ], 'Edition' => [ 'base' => NULL, 'refs' => [ 'AccountInfo$Edition' => '

The edition of your Amazon QuickSight account.

', 'AccountSettings$Edition' => '

The edition of Amazon QuickSight that you\'re currently subscribed to: Enterprise edition or Standard edition.

', 'CreateAccountSubscriptionRequest$Edition' => '

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:

', ], ], 'EmbeddingIdentityType' => [ 'base' => NULL, 'refs' => [ 'GetDashboardEmbedUrlRequest$IdentityType' => '

The authentication method that the user uses to sign in.

', ], ], 'EmbeddingUrl' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserResponse$EmbedUrl' => '

The embed URL for the dashboard.

', 'GenerateEmbedUrlForRegisteredUserResponse$EmbedUrl' => '

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

', 'GetDashboardEmbedUrlResponse$EmbedUrl' => '

A single-use URL that you can put into your server-side webpage to embed your dashboard. 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.

', 'GetSessionEmbedUrlResponse$EmbedUrl' => '

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.

', ], ], 'EmptyVisual' => [ 'base' => '

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.

', 'refs' => [ 'Visual$EmptyVisual' => '

An empty visual.

', ], ], 'Entity' => [ 'base' => '

An object, structure, or sub-structure of an analysis, template, or dashboard.

', 'refs' => [ 'EntityList$member' => NULL, ], ], 'EntityList' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$ViolatedEntities' => '

Lists the violated entities that caused the analysis error

', 'DashboardError$ViolatedEntities' => '

Lists the violated entities that caused the dashboard error.

', 'TemplateError$ViolatedEntities' => '

An error path that shows which entities caused the template error.

', ], ], 'EntryPath' => [ 'base' => NULL, 'refs' => [ 'RegisteredUserQuickSightConsoleEmbeddingConfiguration$InitialPath' => '

The initial URL path for the Amazon QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

', ], ], 'EntryPoint' => [ 'base' => NULL, 'refs' => [ 'GetSessionEmbedUrlRequest$EntryPoint' => '

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

', ], ], 'ErrorInfo' => [ 'base' => '

Error information for the SPICE ingestion of a dataset.

', 'refs' => [ 'Ingestion$ErrorInfo' => '

Error information for this ingestion.

', ], ], 'ExasolParameters' => [ 'base' => '

The required parameters for connecting to an Exasol data source.

', 'refs' => [ 'DataSourceParameters$ExasolParameters' => '

The parameters for Exasol.

', ], ], 'ExceptionResourceType' => [ 'base' => NULL, 'refs' => [ 'LimitExceededException$ResourceType' => '

Limit exceeded.

', 'ResourceExistsException$ResourceType' => '

The resource type for this request.

', 'ResourceNotFoundException$ResourceType' => '

The resource type for this request.

', 'ResourceUnavailableException$ResourceType' => '

The resource type for this request.

', ], ], 'ExcludePeriodConfiguration' => [ 'base' => '

The exclude period of TimeRangeFilter or RelativeDatesFilter.

', 'refs' => [ 'RelativeDatesFilter$ExcludePeriodConfiguration' => '

The configuration for the exclude period of the filter.

', 'TimeRangeFilter$ExcludePeriodConfiguration' => '

The exclude period of the time range filter.

', ], ], 'ExplicitHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields that are built within a visual\'s field wells. These fields can\'t be duplicated to other visuals.

', 'refs' => [ 'ColumnHierarchy$ExplicitHierarchy' => '

The option that determines the hierarchy of the fields that are built within a visual\'s field wells. These fields can\'t be duplicated to other visuals.

', ], ], 'ExplicitHierarchyColumnList' => [ 'base' => NULL, 'refs' => [ 'ExplicitHierarchy$Columns' => '

The list of columns that define the explicit hierarchy.

', ], ], 'ExportHiddenFieldsOption' => [ 'base' => '

Determines if hidden fields are included in an exported dashboard.

', 'refs' => [ 'DashboardVisualPublishOptions$ExportHiddenFieldsOption' => '

Determines if hidden fields are included in an exported dashboard.

', ], ], 'ExportToCSVOption' => [ 'base' => '

Export to .csv option.

', 'refs' => [ 'DashboardPublishOptions$ExportToCSVOption' => '

Export to .csv option.

', ], ], 'ExportWithHiddenFieldsOption' => [ 'base' => '

Determines whether or not hidden fields are visible on exported dashbaords.

', 'refs' => [ 'DashboardPublishOptions$ExportWithHiddenFieldsOption' => '

Determines if hidden fields are exported with a dashboard.

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'CalculatedMeasureField$Expression' => '

The expression in the table calculation.

', 'ConditionalFormattingCustomIconCondition$Expression' => '

The expression that determines the condition of the icon set.

', 'ConditionalFormattingGradientColor$Expression' => '

The expression that determines the formatting configuration for gradient color.

', 'ConditionalFormattingIconSet$Expression' => '

The expression that determines the formatting configuration for the icon set.

', 'ConditionalFormattingSolidColor$Expression' => '

The expression that determines the formatting configuration for solid color.

', 'FilterOperation$ConditionExpression' => '

An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.

', 'RollingDateConfiguration$Expression' => '

The expression of the rolling date configuration.

', 'SheetElementRenderingRule$Expression' => '

The expression of the rendering rules of a sheet.

', 'TopicCalculatedField$Expression' => '

The calculated field expression.

', 'TopicIRMetric$Expression' => '

The expression for the TopicIRMetric.

', ], ], 'FailedKeyRegistrationEntries' => [ 'base' => NULL, 'refs' => [ 'UpdateKeyRegistrationResponse$FailedKeyRegistration' => '

A list of all customer managed key registrations that failed to update.

', ], ], 'FailedKeyRegistrationEntry' => [ 'base' => '

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

', 'refs' => [ 'FailedKeyRegistrationEntries$member' => NULL, ], ], 'FieldBasedTooltip' => [ 'base' => '

The setup for the detailed tooltip.

', 'refs' => [ 'TooltipOptions$FieldBasedTooltip' => '

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

', ], ], 'FieldFolder' => [ 'base' => '

A FieldFolder element is a folder that contains fields and nested subfolders.

', 'refs' => [ 'FieldFolderMap$value' => NULL, ], ], 'FieldFolderDescription' => [ 'base' => NULL, 'refs' => [ 'FieldFolder$description' => '

The description for a field folder.

', ], ], 'FieldFolderMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', 'DataSet$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', 'UpdateDataSetRequest$FieldFolders' => '

The folder that contains fields and nested subfolders for your dataset.

', ], ], 'FieldFolderPath' => [ 'base' => NULL, 'refs' => [ 'FieldFolderMap$key' => NULL, ], ], 'FieldId' => [ 'base' => NULL, 'refs' => [ 'AxisLabelReferenceOptions$FieldId' => '

The field that the axis label is targeted to.

', 'CalculatedMeasureField$FieldId' => '

The custom field ID.

', 'CategoricalDimensionField$FieldId' => '

The custom field ID.

', 'CategoricalMeasureField$FieldId' => '

The custom field ID.

', 'ContributionAnalysisDefault$MeasureFieldId' => '

The measure field that is used in the contribution analysis.

', 'DataBarsOptions$FieldId' => '

The field ID for the data bars options.

', 'DataFieldSeriesItem$FieldId' => '

The field ID of the field that you are setting the axis binding to.

', 'DataPathLabelType$FieldId' => '

The field ID of the field that the data label needs to be applied to.

', 'DataPathValue$FieldId' => '

The field ID of the field that needs to be sorted.

', 'DateDimensionField$FieldId' => '

The custom field ID.

', 'DateMeasureField$FieldId' => '

The custom field ID.

', 'DestinationParameterValueConfiguration$SourceField' => '

The source field ID of the destination parameter.

', 'FieldLabelType$FieldId' => '

Indicates the field that is targeted by the field label.

', 'FieldOrderList$member' => NULL, 'FieldSeriesItem$FieldId' => '

The field ID of the field for which you are setting the axis binding.

', 'FieldSort$FieldId' => '

The sort configuration target field.

', 'FieldTooltipItem$FieldId' => '

The unique ID of the field that is targeted by the tooltip.

', 'FilledMapShapeConditionalFormatting$FieldId' => '

The field ID of the filled map shape.

', 'NumericalDimensionField$FieldId' => '

The custom field ID.

', 'NumericalMeasureField$FieldId' => '

The custom field ID.

', 'PivotFieldSortOptions$FieldId' => '

The field ID for the field sort options.

', 'PivotTableCellConditionalFormatting$FieldId' => '

The field ID of the cell for conditional formatting.

', 'PivotTableFieldOption$FieldId' => '

The field ID of the pivot table field.

', 'PivotTableFieldSubtotalOptions$FieldId' => '

The field ID of the subtotal options.

', 'SelectedFieldList$member' => NULL, 'TableCellConditionalFormatting$FieldId' => '

The field ID of the cell for conditional formatting.

', 'TableFieldOption$FieldId' => '

The field ID for a table field.

', 'TableFieldOrderList$member' => NULL, 'TotalAggregationOption$FieldId' => '

The field id that\'s associated with the total aggregation option.

', 'UnaggregatedField$FieldId' => '

The custom field ID.

', ], ], 'FieldLabelType' => [ 'base' => '

The field label type.

', 'refs' => [ 'DataLabelType$FieldLabelType' => '

Determines the label configuration for the entire field.

', ], ], 'FieldOrderList' => [ 'base' => NULL, 'refs' => [ 'TableFieldOptions$Order' => '

The order of the field IDs that are configured as field options for a table visual.

', ], ], 'FieldSeriesItem' => [ 'base' => '

The field series item configuration of a line chart.

', 'refs' => [ 'SeriesItem$FieldSeriesItem' => '

The field series item configuration of a line chart.

', ], ], 'FieldSort' => [ 'base' => '

The sort configuration for a field in a field well.

', 'refs' => [ 'FieldSortOptions$FieldSort' => '

The sort configuration for a field in a field well.

', 'PivotTableSortBy$Field' => '

The field sort (field id, direction) for the pivot table sort by options.

', ], ], 'FieldSortOptions' => [ 'base' => '

The field sort options in a chart configuration.

', 'refs' => [ 'FieldSortOptionsList$member' => NULL, 'RowSortList$member' => NULL, ], ], 'FieldSortOptionsList' => [ 'base' => NULL, 'refs' => [ 'BarChartSortConfiguration$CategorySort' => '

The sort configuration of category fields.

', 'BarChartSortConfiguration$ColorSort' => '

The sort configuration of color fields in a bar chart.

', 'BarChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'BoxPlotSortConfiguration$CategorySort' => '

The sort configuration of a group by fields.

', 'ComboChartSortConfiguration$CategorySort' => '

The sort configuration of the category field well in a combo chart.

', 'ComboChartSortConfiguration$ColorSort' => '

The sort configuration of the color field well in a combo chart.

', 'FilledMapSortConfiguration$CategorySort' => '

The sort configuration of the location fields.

', 'FunnelChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'HeatMapSortConfiguration$HeatMapRowSort' => '

The field sort configuration of the rows fields.

', 'HeatMapSortConfiguration$HeatMapColumnSort' => '

The column sort configuration for heat map for columns that aren\'t a part of a field well.

', 'KPISortConfiguration$TrendGroupSort' => '

The sort configuration of the trend group fields.

', 'LineChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'LineChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'PieChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'PieChartSortConfiguration$SmallMultiplesSort' => '

The sort configuration of the small multiples field.

', 'RadarChartSortConfiguration$CategorySort' => '

The category sort options of a radar chart.

', 'RadarChartSortConfiguration$ColorSort' => '

The color sort configuration of a radar chart.

', 'SankeyDiagramSortConfiguration$WeightSort' => '

The sort configuration of the weight fields.

', 'TreeMapSortConfiguration$TreeMapSort' => '

The sort configuration of group by fields.

', 'WaterfallChartSortConfiguration$CategorySort' => '

The sort configuration of the category fields.

', 'WordCloudSortConfiguration$CategorySort' => '

The sort configuration of group by fields.

', ], ], 'FieldTooltipItem' => [ 'base' => '

The tooltip item for the fields.

', 'refs' => [ 'TooltipItem$FieldTooltipItem' => '

The tooltip item for the fields.

', ], ], 'FieldValue' => [ 'base' => NULL, 'refs' => [ 'CustomColor$FieldValue' => '

The data value that the color is applied to.

', 'DataPathLabelType$FieldValue' => '

The actual value of the field that is labeled.

', 'DataPathValue$FieldValue' => '

The actual value of the field that needs to be sorted.

', ], ], 'FileFormat' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$Format' => '

File format.

', ], ], 'FilledMapAggregatedFieldWells' => [ 'base' => '

The aggregated field well of the filled map.

', 'refs' => [ 'FilledMapFieldWells$FilledMapAggregatedFieldWells' => '

The aggregated field well of the filled map.

', ], ], 'FilledMapConditionalFormatting' => [ 'base' => '

The conditional formatting of a FilledMapVisual.

', 'refs' => [ 'FilledMapVisual$ConditionalFormatting' => '

The conditional formatting of a FilledMapVisual.

', ], ], 'FilledMapConditionalFormattingOption' => [ 'base' => '

Conditional formatting options of a FilledMapVisual.

', 'refs' => [ 'FilledMapConditionalFormattingOptionList$member' => NULL, ], ], 'FilledMapConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'FilledMapConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options of a FilledMapVisual.

', ], ], 'FilledMapConfiguration' => [ 'base' => '

The configuration for a FilledMapVisual.

', 'refs' => [ 'FilledMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'FilledMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'FilledMapAggregatedFieldWells$Geospatial' => '

The aggregated location field well of the filled map. Values are grouped by location fields.

', ], ], 'FilledMapFieldWells' => [ 'base' => '

The field wells of a FilledMapVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilledMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'FilledMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'FilledMapAggregatedFieldWells$Values' => '

The aggregated color field well of a filled map. Values are aggregated based on location fields.

', ], ], 'FilledMapShapeConditionalFormatting' => [ 'base' => '

The conditional formatting that determines the shape of the filled map.

', 'refs' => [ 'FilledMapConditionalFormattingOption$Shape' => '

The conditional formatting that determines the shape of the filled map.

', ], ], 'FilledMapSortConfiguration' => [ 'base' => '

The sort configuration of a FilledMapVisual.

', 'refs' => [ 'FilledMapConfiguration$SortConfiguration' => '

The sort configuration of a FilledMapVisual.

', ], ], 'FilledMapVisual' => [ 'base' => '

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$FilledMapVisual' => '

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

', ], ], 'Filter' => [ 'base' => '

With a Filter, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterAggMetrics' => [ 'base' => '

The definition for the FilterAggMetrics.

', 'refs' => [ 'FilterAggMetricsList$member' => NULL, ], ], 'FilterAggMetricsList' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$AggMetrics' => '

The agg metrics for the TopicIRFilterOption.

', ], ], 'FilterClass' => [ 'base' => NULL, 'refs' => [ 'TopicFilter$FilterClass' => '

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

', 'TopicIRFilterOption$FilterClass' => '

The filter class for the TopicIRFilterOption.

', ], ], 'FilterControl' => [ 'base' => '

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterControlList$member' => NULL, ], ], 'FilterControlList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$FilterControls' => '

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

', ], ], 'FilterCrossSheetControl' => [ 'base' => '

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

', 'refs' => [ 'FilterControl$CrossSheet' => '

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

', ], ], 'FilterDateTimePickerControl' => [ 'base' => '

A control from a date filter that is used to specify date and time.

', 'refs' => [ 'FilterControl$DateTimePicker' => '

A control from a date filter that is used to specify date and time.

', ], ], 'FilterDropDownControl' => [ 'base' => '

A control to display a dropdown list with buttons that are used to select a single value.

', 'refs' => [ 'FilterControl$Dropdown' => '

A control to display a dropdown list with buttons that are used to select a single value.

', ], ], 'FilterGroup' => [ 'base' => '

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

', 'refs' => [ 'FilterGroupList$member' => NULL, ], ], 'FilterGroupList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$FilterGroups' => '

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'DashboardVersionDefinition$FilterGroups' => '

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'TemplateVersionDefinition$FilterGroups' => '

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

', ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'FilterGroup$Filters' => '

The list of filters that are present in a FilterGroup.

', ], ], 'FilterListConfiguration' => [ 'base' => '

A list of filter configurations.

', 'refs' => [ 'CategoryFilterConfiguration$FilterListConfiguration' => '

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

', ], ], 'FilterListControl' => [ 'base' => '

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

', 'refs' => [ 'FilterControl$List' => '

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

', ], ], 'FilterNullOption' => [ 'base' => NULL, 'refs' => [ 'CustomFilterConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'CustomFilterListConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'FilterListConfiguration$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'NumericEqualityFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'NumericRangeFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'RelativeDatesFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', 'TimeRangeFilter$NullOption' => '

This option determines how null values should be treated when filtering data.

', ], ], 'FilterOperation' => [ 'base' => '

A transform operation that filters rows based on a condition.

', 'refs' => [ 'TransformOperation$FilterOperation' => '

An operation that filters rows based on some condition.

', ], ], 'FilterOperationSelectedFieldsConfiguration' => [ 'base' => '

The configuration of selected fields in theCustomActionFilterOperation.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomActionFilterOperation$SelectedFieldsConfiguration' => '

The configuration that chooses the fields to be filtered.

', ], ], 'FilterOperationTargetVisualsConfiguration' => [ 'base' => '

The configuration of target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'CustomActionFilterOperation$TargetVisualsConfiguration' => '

The configuration that chooses the target visuals to be filtered.

', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'AnalysisSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

', 'DashboardSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

', 'DataSetSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

', 'DataSourceSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

', 'FolderSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

', ], ], 'FilterRelativeDateTimeControl' => [ 'base' => '

A control from a date filter that is used to specify the relative date.

', 'refs' => [ 'FilterControl$RelativeDateTime' => '

A control from a date filter that is used to specify the relative date.

', ], ], 'FilterScopeConfiguration' => [ 'base' => '

The scope configuration for a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterGroup$ScopeConfiguration' => '

The configuration that specifies what scope to apply to a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', ], ], 'FilterSelectableValues' => [ 'base' => '

A list of selectable values that are used in a control.

', 'refs' => [ 'DefaultFilterDropDownControlOptions$SelectableValues' => '

A list of selectable values that are used in a control.

', 'DefaultFilterListControlOptions$SelectableValues' => '

A list of selectable values that are used in a control.

', 'FilterDropDownControl$SelectableValues' => '

A list of selectable values that are used in a control.

', 'FilterListControl$SelectableValues' => '

A list of selectable values that are used in a control.

', ], ], 'FilterSliderControl' => [ 'base' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', 'refs' => [ 'FilterControl$Slider' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', ], ], 'FilterTextAreaControl' => [ 'base' => '

A control to display a text box that is used to enter multiple entries.

', 'refs' => [ 'FilterControl$TextArea' => '

A control to display a text box that is used to enter multiple entries.

', ], ], 'FilterTextFieldControl' => [ 'base' => '

A control to display a text box that is used to enter a single entry.

', 'refs' => [ 'FilterControl$TextField' => '

A control to display a text box that is used to enter a single entry.

', ], ], 'FilterVisualScope' => [ 'base' => NULL, 'refs' => [ 'SheetVisualScopingConfiguration$Scope' => '

The scope of the applied entities. Choose one of the following options:

', ], ], 'FilteredVisualsList' => [ 'base' => NULL, 'refs' => [ 'SheetVisualScopingConfiguration$VisualIds' => '

The selected visuals that the filter is applied to.

', ], ], 'Folder' => [ 'base' => '

A folder in Amazon QuickSight.

', 'refs' => [ 'DescribeFolderResponse$Folder' => '

Information about the folder.

', ], ], 'FolderArnList' => [ 'base' => NULL, 'refs' => [ 'CreateAnalysisRequest$FolderArns' => '

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

', 'CreateDashboardRequest$FolderArns' => '

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

', 'CreateDataSetRequest$FolderArns' => '

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

', 'CreateDataSourceRequest$FolderArns' => '

When you create the data source, Amazon QuickSight adds the data source to these folders.

', ], ], 'FolderColumnList' => [ 'base' => NULL, 'refs' => [ 'FieldFolder$columns' => '

A folder has a list of columns. A column can only be in one folder.

', ], ], 'FolderFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'FolderSearchFilter$Name' => '

The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

', ], ], 'FolderMember' => [ 'base' => '

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

', 'refs' => [ 'CreateFolderMembershipResponse$FolderMember' => '

Information about the member in the folder.

', ], ], 'FolderMemberList' => [ 'base' => NULL, 'refs' => [ 'ListFolderMembersResponse$FolderMemberList' => '

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

', ], ], 'FolderName' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$Name' => '

The name of the folder.

', 'Folder$Name' => '

A display name for the folder.

', 'FolderSummary$Name' => '

The display name of the folder.

', 'UpdateFolderRequest$Name' => '

The name of the folder.

', ], ], 'FolderSearchFilter' => [ 'base' => '

A filter to use to search an Amazon QuickSight folder.

', 'refs' => [ 'FolderSearchFilterList$member' => NULL, ], ], 'FolderSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchFoldersRequest$Filters' => '

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

', ], ], 'FolderSummary' => [ 'base' => '

A summary of information about an existing Amazon QuickSight folder.

', 'refs' => [ 'FolderSummaryList$member' => NULL, ], ], 'FolderSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListFoldersResponse$FolderSummaryList' => '

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

', 'SearchFoldersResponse$FolderSummaryList' => '

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

', ], ], 'FolderType' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$FolderType' => '

The type of folder. By default, folderType is SHARED.

', 'Folder$FolderType' => '

The type of folder it is.

', 'FolderSummary$FolderType' => '

The type of folder.

', ], ], 'Font' => [ 'base' => '

Determines the font settings.

', 'refs' => [ 'FontList$member' => NULL, ], ], 'FontConfiguration' => [ 'base' => '

Configures the display properties of the given text.

', 'refs' => [ 'AxisLabelOptions$FontConfiguration' => '

The font configuration of the axis label.

', 'DataLabelOptions$LabelFontConfiguration' => '

Determines the font configuration of the data labels.

', 'FunnelChartDataLabelOptions$LabelFontConfiguration' => '

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

', 'GaugeChartOptions$PrimaryValueFontConfiguration' => '

The options that determine the primary value font configuration.

', 'KPIOptions$PrimaryValueFontConfiguration' => '

The options that determine the primary value font configuration.

', 'KPIOptions$SecondaryValueFontConfiguration' => '

The options that determine the secondary value font configuration.

', 'LabelOptions$FontConfiguration' => '

The font configuration of the label.

', 'PanelTitleOptions$FontConfiguration' => NULL, 'ReferenceLineLabelConfiguration$FontConfiguration' => '

The font configuration of the label in a reference line.

', 'TableCellStyle$FontConfiguration' => '

The font configuration of the table cells.

', 'TableFieldCustomTextContent$FontConfiguration' => '

The font configuration of the custom text content for the table URL link content.

', ], ], 'FontDecoration' => [ 'base' => NULL, 'refs' => [ 'FontConfiguration$FontDecoration' => '

Determines the appearance of decorative lines on the text.

', ], ], 'FontList' => [ 'base' => NULL, 'refs' => [ 'Typography$FontFamilies' => '

Determines the list of font families.

', ], ], 'FontSize' => [ 'base' => '

The option that determines the text display size.

', 'refs' => [ 'FontConfiguration$FontSize' => '

The option that determines the text display size.

', ], ], 'FontStyle' => [ 'base' => NULL, 'refs' => [ 'FontConfiguration$FontStyle' => '

Determines the text display face that is inherited by the given font family.

', ], ], 'FontWeight' => [ 'base' => '

The option that determines the text display weight, or boldness.

', 'refs' => [ 'FontConfiguration$FontWeight' => '

The option that determines the text display weight, or boldness.

', ], ], 'FontWeightName' => [ 'base' => NULL, 'refs' => [ 'FontWeight$Name' => '

The lexical name for the level of boldness of the text display.

', ], ], 'ForecastComputation' => [ 'base' => '

The forecast computation configuration.

', 'refs' => [ 'Computation$Forecast' => '

The forecast computation configuration.

', ], ], 'ForecastComputationCustomSeasonalityValue' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$CustomSeasonalityValue' => '

The custom seasonality value setup of a forecast computation.

', ], ], 'ForecastComputationSeasonality' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$Seasonality' => '

The seasonality setup of a forecast computation. Choose one of the following options:

', ], ], 'ForecastConfiguration' => [ 'base' => '

The forecast configuration that is used in a line chart\'s display properties.

', 'refs' => [ 'ForecastConfigurationList$member' => NULL, ], ], 'ForecastConfigurationList' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$ForecastConfigurations' => '

The forecast configuration of a line chart.

', ], ], 'ForecastScenario' => [ 'base' => '

The forecast scenario of a forecast in the line chart.

', 'refs' => [ 'ForecastConfiguration$Scenario' => '

The forecast scenario of a forecast in the line chart.

', ], ], 'FormatConfiguration' => [ 'base' => '

The formatting configuration for all types of field.

', 'refs' => [ 'ColumnConfiguration$FormatConfiguration' => '

The format configuration of a column.

', 'UnaggregatedField$FormatConfiguration' => '

The format configuration of the field.

', ], ], 'FreeFormLayoutCanvasSizeOptions' => [ 'base' => '

Configuration options for the canvas of a free-form layout.

', 'refs' => [ 'DefaultFreeFormLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a free-form layout.

', 'FreeFormLayoutConfiguration$CanvasSizeOptions' => NULL, ], ], 'FreeFormLayoutConfiguration' => [ 'base' => '

The configuration of a free-form layout.

', 'refs' => [ 'LayoutConfiguration$FreeFormLayout' => '

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

', ], ], 'FreeFormLayoutElement' => [ 'base' => '

An element within a free-form layout.

', 'refs' => [ 'FreeFromLayoutElementList$member' => NULL, ], ], 'FreeFormLayoutElementBackgroundStyle' => [ 'base' => '

The background style configuration of a free-form layout element.

', 'refs' => [ 'FreeFormLayoutElement$BackgroundStyle' => '

The background style configuration of a free-form layout element.

', ], ], 'FreeFormLayoutElementBorderStyle' => [ 'base' => '

The background style configuration of a free-form layout element.

', 'refs' => [ 'FreeFormLayoutElement$BorderStyle' => '

The border style configuration of a free-form layout element.

', 'FreeFormLayoutElement$SelectedBorderStyle' => '

The border style configuration of a free-form layout element. This border style is used when the element is selected.

', ], ], 'FreeFormLayoutScreenCanvasSizeOptions' => [ 'base' => '

The options that determine the sizing of the canvas used in a free-form layout.

', 'refs' => [ 'FreeFormLayoutCanvasSizeOptions$ScreenCanvasSizeOptions' => '

The options that determine the sizing of the canvas used in a free-form layout.

', ], ], 'FreeFormSectionLayoutConfiguration' => [ 'base' => '

The free-form layout configuration of a section.

', 'refs' => [ 'SectionLayoutConfiguration$FreeFormLayout' => '

The free-form layout configuration of a section.

', ], ], 'FreeFromLayoutElementList' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutConfiguration$Elements' => '

The elements that are included in a free-form layout.

', 'FreeFormSectionLayoutConfiguration$Elements' => '

The elements that are included in the free-form layout.

', ], ], 'FunnelChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartFieldWells$FunnelChartAggregatedFieldWells' => '

The field well configuration of a FunnelChartVisual.

', ], ], 'FunnelChartConfiguration' => [ 'base' => '

The configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartVisual$ChartConfiguration' => '

The configuration of a FunnelChartVisual.

', ], ], 'FunnelChartDataLabelOptions' => [ 'base' => '

The options that determine the presentation of the data labels.

', 'refs' => [ 'FunnelChartConfiguration$DataLabelOptions' => '

The options that determine the presentation of the data labels.

', ], ], 'FunnelChartDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'FunnelChartAggregatedFieldWells$Category' => '

The category field wells of a funnel chart. Values are grouped by category fields.

', ], ], 'FunnelChartFieldWells' => [ 'base' => '

The field well configuration of a FunnelChartVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FunnelChartConfiguration$FieldWells' => '

The field well configuration of a FunnelChartVisual.

', ], ], 'FunnelChartMeasureDataLabelStyle' => [ 'base' => NULL, 'refs' => [ 'FunnelChartDataLabelOptions$MeasureDataLabelStyle' => '

Determines the style of the metric labels.

', ], ], 'FunnelChartMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'FunnelChartAggregatedFieldWells$Values' => '

The value field wells of a funnel chart. Values are aggregated based on categories.

', ], ], 'FunnelChartSortConfiguration' => [ 'base' => '

The sort configuration of a FunnelChartVisual.

', 'refs' => [ 'FunnelChartConfiguration$SortConfiguration' => '

The sort configuration of a FunnelChartVisual.

', ], ], 'FunnelChartVisual' => [ 'base' => '

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$FunnelChartVisual' => '

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

', ], ], 'GaugeChartArcConditionalFormatting' => [ 'base' => '

The options that determine the presentation of the arc of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOption$Arc' => '

The options that determine the presentation of the arc of a GaugeChartVisual.

', ], ], 'GaugeChartColorConfiguration' => [ 'base' => '

The color configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$ColorConfiguration' => '

The color configuration of a GaugeChartVisual.

', ], ], 'GaugeChartConditionalFormatting' => [ 'base' => '

The conditional formatting of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartVisual$ConditionalFormatting' => '

The conditional formatting of a GaugeChartVisual.

', ], ], 'GaugeChartConditionalFormattingOption' => [ 'base' => '

Conditional formatting options of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOptionList$member' => NULL, ], ], 'GaugeChartConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'GaugeChartConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options of a GaugeChartVisual.

', ], ], 'GaugeChartConfiguration' => [ 'base' => '

The configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartVisual$ChartConfiguration' => '

The configuration of a GaugeChartVisual.

', ], ], 'GaugeChartFieldWells' => [ 'base' => '

The field well configuration of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$FieldWells' => '

The field well configuration of a GaugeChartVisual.

', ], ], 'GaugeChartOptions' => [ 'base' => '

The options that determine the presentation of the GaugeChartVisual.

', 'refs' => [ 'GaugeChartConfiguration$GaugeChartOptions' => '

The options that determine the presentation of the GaugeChartVisual.

', ], ], 'GaugeChartPrimaryValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the primary value of a GaugeChartVisual.

', 'refs' => [ 'GaugeChartConditionalFormattingOption$PrimaryValue' => '

The conditional formatting for the primary value of a GaugeChartVisual.

', ], ], 'GaugeChartVisual' => [ 'base' => '

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$GaugeChartVisual' => '

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

', ], ], 'GenerateEmbedUrlForAnonymousUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForAnonymousUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForRegisteredUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateEmbedUrlForRegisteredUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GeoSpatialColumnGroup' => [ 'base' => '

Geospatial column group that denotes a hierarchy.

', 'refs' => [ 'ColumnGroup$GeoSpatialColumnGroup' => '

Geospatial column group that denotes a hierarchy.

', ], ], 'GeoSpatialCountryCode' => [ 'base' => NULL, 'refs' => [ 'GeoSpatialColumnGroup$CountryCode' => '

Country code.

', ], ], 'GeoSpatialDataRole' => [ 'base' => NULL, 'refs' => [ 'ColumnTag$ColumnGeographicRole' => '

A geospatial role for a column.

', ], ], 'GeospatialCoordinateBounds' => [ 'base' => '

The bound options (north, south, west, east) of the geospatial window options.

', 'refs' => [ 'GeospatialWindowOptions$Bounds' => '

The bounds options (north, south, west, east) of the geospatial window options.

', ], ], 'GeospatialHeatmapColorScale' => [ 'base' => '

The color scale specification for the heatmap point style.

', 'refs' => [ 'GeospatialHeatmapConfiguration$HeatmapColor' => '

The color scale specification for the heatmap point style.

', ], ], 'GeospatialHeatmapConfiguration' => [ 'base' => '

The heatmap configuration of the geospatial point style.

', 'refs' => [ 'GeospatialPointStyleOptions$HeatmapConfiguration' => '

The heatmap configuration of the geospatial point style.

', ], ], 'GeospatialHeatmapDataColor' => [ 'base' => '

The color to be used in the heatmap point style.

', 'refs' => [ 'GeospatialHeatmapDataColorList$member' => NULL, ], ], 'GeospatialHeatmapDataColorList' => [ 'base' => NULL, 'refs' => [ 'GeospatialHeatmapColorScale$Colors' => '

The list of colors to be used in heatmap point style.

', ], ], 'GeospatialMapAggregatedFieldWells' => [ 'base' => '

The aggregated field wells for a geospatial map.

', 'refs' => [ 'GeospatialMapFieldWells$GeospatialMapAggregatedFieldWells' => '

The aggregated field well for a geospatial map.

', ], ], 'GeospatialMapConfiguration' => [ 'base' => '

The configuration of a GeospatialMapVisual.

', 'refs' => [ 'GeospatialMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'GeospatialMapFieldWells' => [ 'base' => '

The field wells of a GeospatialMapVisual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'GeospatialMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'GeospatialMapStyleOptions' => [ 'base' => '

The map style options of the geospatial map.

', 'refs' => [ 'FilledMapConfiguration$MapStyleOptions' => '

The map style options of the filled map visual.

', 'GeospatialMapConfiguration$MapStyleOptions' => '

The map style options of the geospatial map.

', ], ], 'GeospatialMapVisual' => [ 'base' => '

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$GeospatialMapVisual' => '

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

', ], ], 'GeospatialPointStyleOptions' => [ 'base' => '

The point style of the geospatial map.

', 'refs' => [ 'GeospatialMapConfiguration$PointStyleOptions' => '

The point style options of the geospatial map.

', ], ], 'GeospatialSelectedPointStyle' => [ 'base' => NULL, 'refs' => [ 'GeospatialPointStyleOptions$SelectedPointStyle' => '

The selected point styles (point, cluster) of the geospatial map.

', ], ], 'GeospatialWindowOptions' => [ 'base' => '

The window options of the geospatial map visual.

', 'refs' => [ 'FilledMapConfiguration$WindowOptions' => '

The window options of the filled map visual.

', 'GeospatialMapConfiguration$WindowOptions' => '

The window options of the geospatial map.

', ], ], 'GetDashboardEmbedUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDashboardEmbedUrlResponse' => [ 'base' => '

Output returned from the GetDashboardEmbedUrl operation.

', 'refs' => [], ], 'GetSessionEmbedUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionEmbedUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlobalTableBorderOptions' => [ 'base' => '

Determines the border options for a table visual.

', 'refs' => [ 'TableCellStyle$Border' => '

The borders for the table cells.

', ], ], 'GradientColor' => [ 'base' => '

Determines the gradient color settings.

', 'refs' => [ 'ConditionalFormattingGradientColor$Color' => '

Determines the color.

', ], ], 'GradientStop' => [ 'base' => '

Determines the gradient stop configuration.

', 'refs' => [ 'GradientStopList$member' => NULL, ], ], 'GradientStopList' => [ 'base' => NULL, 'refs' => [ 'GradientColor$Stops' => '

The list of gradient color stops.

', ], ], 'GridLayoutCanvasSizeOptions' => [ 'base' => '

Configuration options for the canvas of a grid layout.

', 'refs' => [ 'DefaultGridLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a grid layout.

', 'GridLayoutConfiguration$CanvasSizeOptions' => NULL, ], ], 'GridLayoutConfiguration' => [ 'base' => '

The configuration for a grid layout. Also called a tiled layout.

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

', 'refs' => [ 'LayoutConfiguration$GridLayout' => '

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

', 'SheetControlLayoutConfiguration$GridLayout' => '

The configuration that determines the elements and canvas size options of sheet control.

', ], ], 'GridLayoutElement' => [ 'base' => '

An element within a grid layout.

', 'refs' => [ 'GridLayoutElementList$member' => NULL, ], ], 'GridLayoutElementColumnIndex' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$ColumnIndex' => '

The column index for the upper left corner of an element.

', ], ], 'GridLayoutElementColumnSpan' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$ColumnSpan' => '

The width of a grid element expressed as a number of grid columns.

', ], ], 'GridLayoutElementList' => [ 'base' => NULL, 'refs' => [ 'GridLayoutConfiguration$Elements' => '

The elements that are included in a grid layout.

', ], ], 'GridLayoutElementRowIndex' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$RowIndex' => '

The row index for the upper left corner of an element.

', ], ], 'GridLayoutElementRowSpan' => [ 'base' => NULL, 'refs' => [ 'GridLayoutElement$RowSpan' => '

The height of a grid element expressed as a number of grid rows.

', ], ], 'GridLayoutScreenCanvasSizeOptions' => [ 'base' => '

The options that determine the sizing of the canvas used in a grid layout.

', 'refs' => [ 'GridLayoutCanvasSizeOptions$ScreenCanvasSizeOptions' => '

The options that determine the sizing of the canvas used in a grid layout.

', ], ], 'Group' => [ 'base' => '

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

', 'refs' => [ 'CreateGroupResponse$Group' => '

The name of the group.

', 'DescribeGroupResponse$Group' => '

The name of the group.

', 'GroupList$member' => NULL, 'UpdateGroupResponse$Group' => '

The name of the group.

', ], ], 'GroupDescription' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Description' => '

A description for the group that you want to create.

', 'Group$Description' => '

The group description.

', 'UpdateGroupRequest$Description' => '

The description for the group that you want to update.

', ], ], 'GroupFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'GroupSearchFilter$Name' => '

The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME". Currently, the only supported name is GROUP_NAME.

', ], ], 'GroupFilterOperator' => [ 'base' => NULL, 'refs' => [ 'GroupSearchFilter$Operator' => '

The comparison operator that you want to use as a filter, for example "Operator": "StartsWith". Currently, the only supported operator is StartsWith.

', ], ], 'GroupList' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$GroupList' => '

The list of the groups.

', 'ListUserGroupsResponse$GroupList' => '

The list of groups the user is a member of.

', 'SearchGroupsResponse$GroupList' => '

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

', ], ], 'GroupMember' => [ 'base' => '

A member of an Amazon QuickSight group. Currently, group members must be users. Groups can\'t be members of another group. .

', 'refs' => [ 'CreateGroupMembershipResponse$GroupMember' => '

The group member.

', 'DescribeGroupMembershipResponse$GroupMember' => NULL, 'GroupMemberList$member' => NULL, ], ], 'GroupMemberList' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembershipsResponse$GroupMemberList' => '

The list of the members of the group.

', ], ], 'GroupMemberName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$MemberName' => '

The name of the user that you want to add to the group membership.

', 'DeleteGroupMembershipRequest$MemberName' => '

The name of the user that you want to delete from the group membership.

', 'DescribeGroupMembershipRequest$MemberName' => '

The user name of the user that you want to search for.

', 'GroupMember$MemberName' => '

The name of the group member (user).

', ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$GroupName' => '

The name of the group that you want to add the user to.

', 'CreateGroupRequest$GroupName' => '

A name for the group that you want to create.

', 'CreateRoleMembershipRequest$MemberName' => '

The name of the group that you want to add to the role.

', 'DeleteGroupMembershipRequest$GroupName' => '

The name of the group that you want to delete the user from.

', 'DeleteGroupRequest$GroupName' => '

The name of the group that you want to delete.

', 'DeleteRoleMembershipRequest$MemberName' => '

The name of the group.

', 'DescribeGroupMembershipRequest$GroupName' => '

The name of the group that you want to search.

', 'DescribeGroupRequest$GroupName' => '

The name of the group that you want to describe.

', 'Group$GroupName' => '

The name of the group.

', 'ListGroupMembershipsRequest$GroupName' => '

The name of the group that you want to see a membership list of.

', 'UpdateGroupRequest$GroupName' => '

The name of the group that you want to update.

', ], ], 'GroupSearchFilter' => [ 'base' => '

A GroupSearchFilter object that you want to apply to your search.

', 'refs' => [ 'GroupSearchFilterList$member' => NULL, ], ], 'GroupSearchFilterList' => [ 'base' => NULL, 'refs' => [ 'SearchGroupsRequest$Filters' => '

The structure for the search filters that you want to apply to your search.

', ], ], 'GroupsList' => [ 'base' => NULL, 'refs' => [ 'CreateAccountSubscriptionRequest$AdminGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AuthorGroup' => '

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.

', 'CreateAccountSubscriptionRequest$ReaderGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AdminProGroup' => '

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.

', 'CreateAccountSubscriptionRequest$AuthorProGroup' => '

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.

', 'CreateAccountSubscriptionRequest$ReaderProGroup' => '

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.

', 'ListRoleMembershipsResponse$MembersList' => '

The list of groups associated with a role

', ], ], 'GrowthRateComputation' => [ 'base' => '

The growth rate computation configuration.

', 'refs' => [ 'Computation$GrowthRate' => '

The growth rate computation configuration.

', ], ], 'GrowthRatePeriodSize' => [ 'base' => NULL, 'refs' => [ 'GrowthRateComputation$PeriodSize' => '

The period size setup of a growth rate computation.

', ], ], 'GutterStyle' => [ 'base' => '

The display options for gutter spacing between tiles on a sheet.

', 'refs' => [ 'TileLayoutStyle$Gutter' => '

The gutter settings that apply between tiles.

', ], ], 'HeaderFooterSectionConfiguration' => [ 'base' => '

The configuration of a header or footer section.

', 'refs' => [ 'HeaderFooterSectionConfigurationList$member' => NULL, ], ], 'HeaderFooterSectionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutConfiguration$HeaderSections' => '

A list of header section configurations.

', 'SectionBasedLayoutConfiguration$FooterSections' => '

A list of footer section configurations.

', ], ], 'HeatMapAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a heat map.

', 'refs' => [ 'HeatMapFieldWells$HeatMapAggregatedFieldWells' => '

The aggregated field wells of a heat map.

', ], ], 'HeatMapConfiguration' => [ 'base' => '

The configuration of a heat map.

', 'refs' => [ 'HeatMapVisual$ChartConfiguration' => '

The configuration of a heat map.

', ], ], 'HeatMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'HeatMapAggregatedFieldWells$Rows' => '

The rows field well of a heat map.

', 'HeatMapAggregatedFieldWells$Columns' => '

The columns field well of a heat map.

', ], ], 'HeatMapFieldWells' => [ 'base' => '

The field well configuration of a heat map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'HeatMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'HeatMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'HeatMapAggregatedFieldWells$Values' => '

The values field well of a heat map.

', ], ], 'HeatMapSortConfiguration' => [ 'base' => '

The sort configuration of a heat map.

', 'refs' => [ 'HeatMapConfiguration$SortConfiguration' => '

The sort configuration of a heat map.

', ], ], 'HeatMapVisual' => [ 'base' => '

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$HeatMapVisual' => '

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

', ], ], 'HexColor' => [ 'base' => NULL, 'refs' => [ 'ColorList$member' => NULL, 'ConditionalFormattingCustomIconCondition$Color' => '

Determines the color of the icon.

', 'ConditionalFormattingSolidColor$Color' => '

Determines the color.

', 'CustomColor$Color' => '

The color that is applied to the data value.

', 'DataBarsOptions$PositiveColor' => '

The color of the positive data bar.

', 'DataBarsOptions$NegativeColor' => '

The color of the negative data bar.

', 'DataColor$Color' => '

The color that is applied to the data value.

', 'DataColorPalette$EmptyFillColor' => '

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

', 'DataLabelOptions$LabelColor' => '

Determines the color of the data labels.

', 'DataPathColor$Color' => '

The color that needs to be applied to the element.

', 'FontConfiguration$FontColor' => '

Determines the color of the text.

', 'FunnelChartDataLabelOptions$LabelColor' => '

The color of the data label text.

', 'GaugeChartColorConfiguration$ForegroundColor' => '

The foreground color configuration of a GaugeChartVisual.

', 'GaugeChartColorConfiguration$BackgroundColor' => '

The background color configuration of a GaugeChartVisual.

', 'GeospatialHeatmapDataColor$Color' => '

The hex color to be used in the heatmap point style.

', 'GradientStop$Color' => '

Determines the color.

', 'KPISparklineOptions$Color' => '

The color of the sparkline.

', 'LineChartMarkerStyleSettings$MarkerColor' => '

Color of marker in the series.

', 'RadarChartConfiguration$AlternateBandEvenColor' => '

The color of the even-numbered alternate bands of a radar chart.

', 'RadarChartConfiguration$AlternateBandOddColor' => '

The color of the odd-numbered alternate bands of a radar chart.

', 'ReferenceLineLabelConfiguration$FontColor' => '

The font color configuration of the label in a reference line.

', 'ReferenceLineStyleConfiguration$Color' => '

The hex color of the reference line.

', 'RowAlternateColorList$member' => NULL, 'SimpleClusterMarker$Color' => '

The color of the simple cluster marker.

', 'TableBorderOptions$Color' => '

The color of a table border.

', 'TableCellStyle$BackgroundColor' => '

The background color for the table cells.

', 'UIColorPalette$PrimaryForeground' => '

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

', 'UIColorPalette$PrimaryBackground' => '

The background color that applies to visuals and other high emphasis UI.

', 'UIColorPalette$SecondaryForeground' => '

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

', 'UIColorPalette$SecondaryBackground' => '

The background color that applies to the sheet background and sheet controls.

', 'UIColorPalette$Accent' => '

This color is that applies to selected states and buttons.

', 'UIColorPalette$AccentForeground' => '

The foreground color that applies to any text or other elements that appear over the accent color.

', 'UIColorPalette$Danger' => '

The color that applies to error messages.

', 'UIColorPalette$DangerForeground' => '

The foreground color that applies to any text or other elements that appear over the error color.

', 'UIColorPalette$Warning' => '

This color that applies to warning and informational messages.

', 'UIColorPalette$WarningForeground' => '

The foreground color that applies to any text or other elements that appear over the warning color.

', 'UIColorPalette$Success' => '

The color that applies to success messages, for example the check mark for a successful download.

', 'UIColorPalette$SuccessForeground' => '

The foreground color that applies to any text or other elements that appear over the success color.

', 'UIColorPalette$Dimension' => '

The color that applies to the names of fields that are identified as dimensions.

', 'UIColorPalette$DimensionForeground' => '

The foreground color that applies to any text or other elements that appear over the dimension color.

', 'UIColorPalette$Measure' => '

The color that applies to the names of fields that are identified as measures.

', 'UIColorPalette$MeasureForeground' => '

The foreground color that applies to any text or other elements that appear over the measure color.

', 'VisualPalette$ChartColor' => '

The chart color options for the visual palette.

', 'WaterfallChartGroupColorConfiguration$PositiveBarColor' => '

Defines the color for the positive bars of a waterfall chart.

', 'WaterfallChartGroupColorConfiguration$NegativeBarColor' => '

Defines the color for the negative bars of a waterfall chart.

', 'WaterfallChartGroupColorConfiguration$TotalBarColor' => '

Defines the color for the total bars of a waterfall chart.

', ], ], 'HexColorWithTransparency' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElementBackgroundStyle$Color' => '

The background color of a free-form layout element.

', 'FreeFormLayoutElementBorderStyle$Color' => '

The border color of a free-form layout element.

', 'PanelConfiguration$BorderColor' => '

Sets the line color of panel borders.

', 'PanelConfiguration$BackgroundColor' => '

Sets the background color for each panel.

', ], ], 'HierarchyId' => [ 'base' => NULL, 'refs' => [ 'CategoricalDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'DateDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'DateTimeHierarchy$HierarchyId' => '

The hierarchy ID of the DateTime hierarchy.

', 'ExplicitHierarchy$HierarchyId' => '

The hierarchy ID of the explicit hierarchy.

', 'NumericalDimensionField$HierarchyId' => '

The custom hierarchy ID.

', 'PredefinedHierarchy$HierarchyId' => '

The hierarchy ID of the predefined hierarchy.

', ], ], 'HistogramAggregatedFieldWells' => [ 'base' => '

The field well configuration of a histogram.

', 'refs' => [ 'HistogramFieldWells$HistogramAggregatedFieldWells' => '

The field well configuration of a histogram.

', ], ], 'HistogramBinOptions' => [ 'base' => '

The options that determine the presentation of histogram bins.

', 'refs' => [ 'HistogramConfiguration$BinOptions' => '

The options that determine the presentation of histogram bins.

', ], ], 'HistogramBinType' => [ 'base' => NULL, 'refs' => [ 'HistogramBinOptions$SelectedBinType' => '

The options that determine the selected bin type.

', ], ], 'HistogramConfiguration' => [ 'base' => '

The configuration for a HistogramVisual.

', 'refs' => [ 'HistogramVisual$ChartConfiguration' => '

The configuration for a HistogramVisual.

', ], ], 'HistogramFieldWells' => [ 'base' => '

The field well configuration of a histogram.

', 'refs' => [ 'HistogramConfiguration$FieldWells' => '

The field well configuration of a histogram.

', ], ], 'HistogramMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'HistogramAggregatedFieldWells$Values' => '

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

', ], ], 'HistogramVisual' => [ 'base' => '

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$HistogramVisual' => '

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

', ], ], 'HorizontalTextAlignment' => [ 'base' => NULL, 'refs' => [ 'PanelTitleOptions$HorizontalTextAlignment' => '

Sets the horizontal text alignment of the title within each panel.

', 'TableCellStyle$HorizontalTextAlignment' => '

The horizontal text alignment (left, center, right, auto) for the table cells.

', ], ], 'Host' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Host' => '

Host.

', 'AuroraPostgreSqlParameters$Host' => '

The Amazon Aurora PostgreSQL-Compatible host to connect to.

', 'DatabricksParameters$Host' => '

The host name of the Databricks data source.

', 'ExasolParameters$Host' => '

The hostname or IP address of the Exasol data source.

', 'MariaDbParameters$Host' => '

Host.

', 'MySqlParameters$Host' => '

Host.

', 'OracleParameters$Host' => '

An Oracle host.

', 'PostgreSqlParameters$Host' => '

Host.

', 'PrestoParameters$Host' => '

Host.

', 'RedshiftParameters$Host' => '

Host. This field can be blank if ClusterId is provided.

', 'SnowflakeParameters$Host' => '

Host.

', 'SparkParameters$Host' => '

Host.

', 'SqlServerParameters$Host' => '

Host.

', 'StarburstParameters$Host' => '

The host name of the Starburst data source.

', 'TeradataParameters$Host' => '

Host.

', 'TrinoParameters$Host' => '

The host name of the Trino data source.

', ], ], 'IAMPolicyAssignment' => [ 'base' => '

An Identity and Access Management (IAM) policy assignment.

', 'refs' => [ 'DescribeIAMPolicyAssignmentResponse$IAMPolicyAssignment' => '

Information describing the IAM policy assignment.

', ], ], 'IAMPolicyAssignmentName' => [ 'base' => NULL, 'refs' => [ 'ActiveIAMPolicyAssignment$AssignmentName' => '

A name for the IAM policy assignment.

', 'CreateIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

', 'CreateIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment. The name must be unique within the Amazon Web Services account.

', 'DeleteIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment.

', 'DeleteIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment.

', 'DescribeIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule.

', 'IAMPolicyAssignment$AssignmentName' => '

Assignment name.

', 'IAMPolicyAssignmentSummary$AssignmentName' => '

Assignment name.

', 'UpdateIAMPolicyAssignmentRequest$AssignmentName' => '

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

', 'UpdateIAMPolicyAssignmentResponse$AssignmentName' => '

The name of the assignment or rule.

', ], ], 'IAMPolicyAssignmentSummary' => [ 'base' => '

IAM policy assignment summary.

', 'refs' => [ 'IAMPolicyAssignmentSummaryList$member' => NULL, ], ], 'IAMPolicyAssignmentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListIAMPolicyAssignmentsResponse$IAMPolicyAssignments' => '

Information describing the IAM policy assignments.

', ], ], 'IPv4Address' => [ 'base' => NULL, 'refs' => [ 'DnsResolverList$member' => NULL, ], ], 'Icon' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingCustomIconOptions$Icon' => '

Determines the type of icon.

', ], ], 'Identifier' => [ 'base' => '

The definition for the identifier.

', 'refs' => [ 'CalculatedFieldReferenceList$member' => NULL, 'FilterAggMetrics$MetricOperand' => '

The metric operand of the FilterAggMetrics.

', 'OperandList$member' => NULL, 'TopicIRFilterOption$OperandField' => '

The operand field for the TopicIRFilterOption.

', 'TopicIRGroupBy$FieldName' => '

The field name for the TopicIRGroupBy.

', 'TopicIRMetric$MetricId' => '

The metric ID for the TopicIRMetric.

', 'TopicSortClause$Operand' => '

The operand for a TopicSortClause.

', ], ], 'IdentityCenterConfiguration' => [ 'base' => '

The parameters for an IAM Identity Center configuration.

', 'refs' => [ 'RedshiftParameters$IdentityCenterConfiguration' => '

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.

', ], ], 'IdentityMap' => [ 'base' => NULL, 'refs' => [ 'CreateIAMPolicyAssignmentRequest$Identities' => '

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

', 'CreateIAMPolicyAssignmentResponse$Identities' => '

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

', 'IAMPolicyAssignment$Identities' => '

Identities.

', 'UpdateIAMPolicyAssignmentRequest$Identities' => '

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

', 'UpdateIAMPolicyAssignmentResponse$Identities' => '

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

', ], ], 'IdentityName' => [ 'base' => NULL, 'refs' => [ 'IdentityNameList$member' => NULL, ], ], 'IdentityNameList' => [ 'base' => NULL, 'refs' => [ 'IdentityMap$value' => NULL, ], ], 'IdentityStore' => [ 'base' => NULL, 'refs' => [ 'CreateNamespaceRequest$IdentityStore' => '

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

', 'CreateNamespaceResponse$IdentityStore' => '

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

', 'NamespaceInfoV2$IdentityStore' => '

The identity store used for the namespace.

', ], ], 'IdentityType' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$IdentityType' => '

The identity type that your Amazon QuickSight account uses to manage the identity of users.

', 'User$IdentityType' => '

The type of identity authentication used by the user.

', ], ], 'IdentityTypeNotSupportedException' => [ 'base' => '

The identity type specified isn\'t supported. Supported identity types include IAM and QUICKSIGHT.

', 'refs' => [], ], 'IncrementalRefresh' => [ 'base' => '

The incremental refresh configuration for a dataset.

', 'refs' => [ 'RefreshConfiguration$IncrementalRefresh' => '

The incremental refresh for the dataset.

', ], ], 'Ingestion' => [ 'base' => '

Information about the SPICE ingestion for a dataset.

', 'refs' => [ 'DescribeIngestionResponse$Ingestion' => '

Information about the ingestion.

', 'Ingestions$member' => NULL, ], ], 'IngestionErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorInfo$Type' => '

Error type.

', ], ], 'IngestionId' => [ 'base' => NULL, 'refs' => [ 'CancelIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'CancelIngestionResponse$IngestionId' => '

An ID for the ingestion.

', 'CreateIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'CreateIngestionResponse$IngestionId' => '

An ID for the ingestion.

', 'DescribeIngestionRequest$IngestionId' => '

An ID for the ingestion.

', 'Ingestion$IngestionId' => '

Ingestion ID.

', ], ], 'IngestionMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListIngestionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', ], ], 'IngestionRequestSource' => [ 'base' => NULL, 'refs' => [ 'Ingestion$RequestSource' => '

Event source for this ingestion.

', ], ], 'IngestionRequestType' => [ 'base' => 'This defines the type of ingestion request. This is returned as part of create ingestion response.', 'refs' => [ 'Ingestion$RequestType' => '

Type of this ingestion.

', ], ], 'IngestionStatus' => [ 'base' => NULL, 'refs' => [ 'CreateIngestionResponse$IngestionStatus' => '

The ingestion status.

', 'Ingestion$IngestionStatus' => '

Ingestion status.

', ], ], 'IngestionType' => [ 'base' => 'This defines the type of ingestion user wants to trigger. This is part of create ingestion request.', 'refs' => [ 'CreateIngestionRequest$IngestionType' => '

The type of ingestion that you want to create.

', 'RefreshSchedule$RefreshType' => '

The type of refresh that a datset undergoes. Valid values are as follows:

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

', ], ], 'Ingestions' => [ 'base' => NULL, 'refs' => [ 'ListIngestionsResponse$Ingestions' => '

A list of the ingestions.

', ], ], 'InnerFilter' => [ 'base' => '

The InnerFilter defines the subset of data to be used with the NestedFilter.

', 'refs' => [ 'NestedFilter$InnerFilter' => '

The InnerFilter defines the subset of data to be used with the NestedFilter.

', ], ], 'InputColumn' => [ 'base' => '

Metadata for a column that is used as the input of a transform operation.

', 'refs' => [ 'InputColumnList$member' => NULL, ], ], 'InputColumnDataType' => [ 'base' => NULL, 'refs' => [ 'InputColumn$Type' => '

The data type of the column.

', ], ], 'InputColumnList' => [ 'base' => NULL, 'refs' => [ 'CustomSql$Columns' => '

The column schema from the SQL query result set.

', 'RelationalTable$InputColumns' => '

The column schema of the table.

', 'S3Source$InputColumns' => '

A physical table type for an S3 data source.

For files that aren\'t JSON, only STRING data types are supported in input columns.

', ], ], 'InsightConfiguration' => [ 'base' => '

The configuration of an insight visual.

', 'refs' => [ 'InsightVisual$InsightConfiguration' => '

The configuration of an insight visual.

', ], ], 'InsightVisual' => [ 'base' => '

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$InsightVisual' => '

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'RdsParameters$InstanceId' => '

Instance ID.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Anchor$Offset' => '

The offset of the Anchor.

', 'ArcAxisConfiguration$ReserveRange' => '

The reserved range of the arc axis.

', 'AxisLinearScale$StepCount' => '

The step count setup of a linear axis.

', 'DisplayFormatOptions$FractionDigits' => '

Determines the number of fraction digits.

', 'ExcludePeriodConfiguration$Amount' => '

The amount or number of the exclude period.

', 'RelativeDatesFilter$RelativeDateValue' => '

The date value of the filter.

', 'TopBottomFilter$Limit' => '

The number of items to include in the top bottom filter results.

', 'TopicIRComparisonMethod$WindowSize' => '

The window size for the TopicIRComparisonMethod.

', ], ], 'IntegerDatasetParameter' => [ 'base' => '

An integer parameter for a dataset.

', 'refs' => [ 'DatasetParameter$IntegerDatasetParameter' => '

An integer parameter that is created in the dataset.

', ], ], 'IntegerDatasetParameterDefaultValue' => [ 'base' => '

The default value for the integer parameter.

', 'refs' => [ 'IntegerDatasetParameterValueList$member' => NULL, ], ], 'IntegerDatasetParameterDefaultValues' => [ 'base' => '

The default values of an integer parameter.

', 'refs' => [ 'IntegerDatasetParameter$DefaultValues' => '

A list of default values for a given integer parameter. This structure only accepts static values.

', ], ], 'IntegerDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'IntegerDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given integer parameter.

', 'NewDefaultValues$IntegerStaticValues' => '

A list of static default values for a given integer parameter.

', ], ], 'IntegerDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$IntegerValues' => '

A list of integer-type parameter values.

', 'IntegerDefaultValues$StaticValues' => '

The static values of the IntegerDefaultValues.

', ], ], 'IntegerDefaultValues' => [ 'base' => '

The default values of the IntegerParameterDeclaration.

', 'refs' => [ 'IntegerParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'IntegerParameter' => [ 'base' => '

An integer parameter.

', 'refs' => [ 'IntegerParameterList$member' => NULL, ], ], 'IntegerParameterDeclaration' => [ 'base' => '

A parameter declaration for the Integer data type.

', 'refs' => [ 'ParameterDeclaration$IntegerParameterDeclaration' => '

A parameter declaration for the Integer data type.

', ], ], 'IntegerParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$IntegerParameters' => '

The parameters that have a data type of integer.

', ], ], 'IntegerValueWhenUnsetConfiguration' => [ 'base' => '

A parameter declaration for the Integer data type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'IntegerParameterDeclaration$ValueWhenUnset' => '

A parameter declaration for the Integer data type.

', ], ], 'InternalFailureException' => [ 'base' => '

An internal failure occurred.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The NextToken value isn\'t valid.

', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => '

One or more parameters has a value that isn\'t valid.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

You don\'t have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

', 'refs' => [], ], 'InvalidTopicReviewedAnswer' => [ 'base' => '

The definition for a InvalidTopicReviewedAnswer.

', 'refs' => [ 'InvalidTopicReviewedAnswers$member' => NULL, ], ], 'InvalidTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$InvalidAnswers' => '

The definition of Answers that are invalid and not created.

', 'BatchDeleteTopicReviewedAnswerResponse$InvalidAnswers' => '

The definition of Answers that are invalid and not deleted.

', ], ], 'IpRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'IpRestrictionRuleMap$value' => NULL, ], ], 'IpRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$IpRestrictionRuleMap' => '

A map that describes the IP rules with CIDR range and description.

', 'UpdateIpRestrictionRequest$IpRestrictionRuleMap' => '

A map that describes the updated IP rules with CIDR ranges and descriptions.

', ], ], 'ItemsLimitConfiguration' => [ 'base' => '

The limit configuration of the visual display for an axis.

', 'refs' => [ 'BarChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories displayed in a bar chart.

', 'BarChartSortConfiguration$ColorItemsLimit' => '

The limit on the number of values displayed in a bar chart.

', 'BarChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'ComboChartSortConfiguration$CategoryItemsLimit' => '

The item limit configuration for the category field well of a combo chart.

', 'ComboChartSortConfiguration$ColorItemsLimit' => '

The item limit configuration of the color field well in a combo chart.

', 'FunnelChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories displayed.

', 'HeatMapSortConfiguration$HeatMapRowItemsLimitConfiguration' => '

The limit on the number of rows that are displayed in a heat map.

', 'HeatMapSortConfiguration$HeatMapColumnItemsLimitConfiguration' => '

The limit on the number of columns that are displayed in a heat map.

', 'LineChartSortConfiguration$CategoryItemsLimitConfiguration' => '

The limit on the number of categories that are displayed in a line chart.

', 'LineChartSortConfiguration$ColorItemsLimitConfiguration' => '

The limit on the number of lines that are displayed in a line chart.

', 'LineChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'PieChartSortConfiguration$CategoryItemsLimit' => '

The limit on the number of categories that are displayed in a pie chart.

', 'PieChartSortConfiguration$SmallMultiplesLimitConfiguration' => '

The limit on the number of small multiples panels that are displayed.

', 'RadarChartSortConfiguration$CategoryItemsLimit' => '

The category items limit for a radar chart.

', 'RadarChartSortConfiguration$ColorItemsLimit' => '

The color items limit of a radar chart.

', 'SankeyDiagramSortConfiguration$SourceItemsLimit' => '

The limit on the number of source nodes that are displayed in a sankey diagram.

', 'SankeyDiagramSortConfiguration$DestinationItemsLimit' => '

The limit on the number of destination nodes that are displayed in a sankey diagram.

', 'ScatterPlotSortConfiguration$ScatterPlotLimitConfiguration' => NULL, 'TreeMapSortConfiguration$TreeMapGroupItemsLimitConfiguration' => '

The limit on the number of groups that are displayed.

', 'WaterfallChartSortConfiguration$BreakdownItemsLimit' => '

The limit on the number of bar groups that are displayed.

', 'WordCloudSortConfiguration$CategoryItemsLimit' => '

The limit on the number of groups that are displayed in a word cloud.

', ], ], 'JiraParameters' => [ 'base' => '

The parameters for Jira.

', 'refs' => [ 'DataSourceParameters$JiraParameters' => '

The parameters for Jira.

', ], ], 'JoinInstruction' => [ 'base' => '

The instructions associated with a join.

', 'refs' => [ 'LogicalTableSource$JoinInstruction' => '

Specifies the result of a join of two logical tables.

', ], ], 'JoinKeyProperties' => [ 'base' => '

Properties associated with the columns participating in a join.

', 'refs' => [ 'JoinInstruction$LeftJoinKeyProperties' => '

Join key properties of the left operand.

', 'JoinInstruction$RightJoinKeyProperties' => '

Join key properties of the right operand.

', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'JoinInstruction$Type' => '

The type of join that it is.

', ], ], 'KPIActualValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the actual value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ActualValue' => '

The conditional formatting for the actual value of a KPI visual.

', ], ], 'KPIComparisonValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the comparison value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ComparisonValue' => '

The conditional formatting for the comparison value of a KPI visual.

', ], ], 'KPIConditionalFormatting' => [ 'base' => '

The conditional formatting of a KPI visual.

', 'refs' => [ 'KPIVisual$ConditionalFormatting' => '

The conditional formatting of a KPI visual.

', ], ], 'KPIConditionalFormattingOption' => [ 'base' => '

The conditional formatting options of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOptionList$member' => NULL, ], ], 'KPIConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'KPIConditionalFormatting$ConditionalFormattingOptions' => '

The conditional formatting options of a KPI visual.

', ], ], 'KPIConfiguration' => [ 'base' => '

The configuration of a KPI visual.

', 'refs' => [ 'KPIVisual$ChartConfiguration' => '

The configuration of a KPI visual.

', ], ], 'KPIFieldWells' => [ 'base' => '

The field well configuration of a KPI visual.

', 'refs' => [ 'KPIConfiguration$FieldWells' => '

The field well configuration of a KPI visual.

', ], ], 'KPIOptions' => [ 'base' => '

The options that determine the presentation of a KPI visual.

', 'refs' => [ 'KPIConfiguration$KPIOptions' => '

The options that determine the presentation of a KPI visual.

', ], ], 'KPIPrimaryValueConditionalFormatting' => [ 'base' => '

The conditional formatting for the primary value of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$PrimaryValue' => '

The conditional formatting for the primary value of a KPI visual.

', ], ], 'KPIProgressBarConditionalFormatting' => [ 'base' => '

The conditional formatting for the progress bar of a KPI visual.

', 'refs' => [ 'KPIConditionalFormattingOption$ProgressBar' => '

The conditional formatting for the progress bar of a KPI visual.

', ], ], 'KPISortConfiguration' => [ 'base' => '

The sort configuration of a KPI visual.

', 'refs' => [ 'KPIConfiguration$SortConfiguration' => '

The sort configuration of a KPI visual.

', ], ], 'KPISparklineOptions' => [ 'base' => '

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

', 'refs' => [ 'KPIOptions$Sparkline' => '

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

', ], ], 'KPISparklineType' => [ 'base' => NULL, 'refs' => [ 'KPISparklineOptions$Type' => '

The type of the sparkline.

', ], ], 'KPIVisual' => [ 'base' => '

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$KPIVisual' => '

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

', ], ], 'KPIVisualLayoutOptions' => [ 'base' => '

The options that determine the layout a KPI visual.

', 'refs' => [ 'KPIOptions$VisualLayoutOptions' => '

The options that determine the layout a KPI visual.

', ], ], 'KPIVisualStandardLayout' => [ 'base' => '

The standard layout of the KPI visual.

', 'refs' => [ 'KPIVisualLayoutOptions$StandardLayout' => '

The standard layout of the KPI visual.

', ], ], 'KPIVisualStandardLayoutType' => [ 'base' => NULL, 'refs' => [ 'KPIVisualStandardLayout$Type' => '

The standard layout type.

', ], ], 'KeyRegistration' => [ 'base' => NULL, 'refs' => [ 'DescribeKeyRegistrationResponse$KeyRegistration' => '

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

', 'UpdateKeyRegistrationRequest$KeyRegistration' => '

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

', ], ], 'LabelOptions' => [ 'base' => '

The share label options for the labels.

', 'refs' => [ 'AxisTickLabelOptions$LabelOptions' => '

Determines whether or not the axis ticks are visible.

', 'DateTimePickerControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'DropDownControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'LegendOptions$Title' => '

The custom title for the legend.

', 'ListControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'RelativeDateTimeControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'SliderControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'TextAreaControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', 'TextFieldControlDisplayOptions$TitleOptions' => '

The options to configure the title visibility, name, and font size.

', ], ], 'Latitude' => [ 'base' => NULL, 'refs' => [ 'GeospatialCoordinateBounds$North' => '

The latitude of the north bound of the geospatial coordinate bounds.

', 'GeospatialCoordinateBounds$South' => '

The latitude of the south bound of the geospatial coordinate bounds.

', ], ], 'Layout' => [ 'base' => '

A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon QuickSight User Guide.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'LayoutList$member' => NULL, ], ], 'LayoutConfiguration' => [ 'base' => '

The configuration that determines what the type of layout will be used on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'Layout$Configuration' => '

The configuration that determines what the type of layout for a sheet.

', ], ], 'LayoutElementType' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElement$ElementType' => '

The type of element.

', 'GridLayoutElement$ElementType' => '

The type of element.

', ], ], 'LayoutList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Layouts' => '

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

', ], ], 'LegendOptions' => [ 'base' => '

The options for the legend setup of a visual.

', 'refs' => [ 'BarChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'BoxPlotChartConfiguration$Legend' => NULL, 'ComboChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'FilledMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'GeospatialMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'HeatMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'LineChartConfiguration$Legend' => '

The legend configuration of a line chart.

', 'PieChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'RadarChartConfiguration$Legend' => '

The legend display setup of the visual.

', 'ScatterPlotConfiguration$Legend' => '

The legend display setup of the visual.

', 'TreeMapConfiguration$Legend' => '

The legend display setup of the visual.

', 'WaterfallChartConfiguration$Legend' => '

The legend configuration of a waterfall visual.

', ], ], 'LegendPosition' => [ 'base' => NULL, 'refs' => [ 'LegendOptions$Position' => '

The positions for the legend. Choose one of the following options:

', ], ], 'Length' => [ 'base' => 'String based length that is composed of value and unit', 'refs' => [ 'Spacing$Top' => '

Define the top spacing.

', 'Spacing$Bottom' => '

Define the bottom spacing.

', 'Spacing$Left' => '

Define the left spacing.

', 'Spacing$Right' => '

Define the right spacing.

', ], ], 'LimitExceededException' => [ 'base' => '

A limit is exceeded.

', 'refs' => [], ], 'LimitedString' => [ 'base' => NULL, 'refs' => [ 'AggFunction$PeriodField' => '

The period field for an Agg function.

', 'AggregationFunctionParameters$key' => NULL, 'AggregationFunctionParameters$value' => NULL, 'AggregationPartitionBy$FieldName' => '

The field Name for an AggregationPartitionBy.

', 'CellValueSynonym$CellValue' => '

The cell value.

', 'ContributionAnalysisFactor$FieldName' => '

The field name of the ContributionAnalysisFactor.

', 'CreateTopicReviewedAnswer$Question' => '

The Question to be created.

', 'DataAggregation$DefaultDateColumnName' => '

The column name for the default date.

', 'DatasetMetadata$DatasetName' => '

The name of the dataset.

', 'DatasetMetadata$DatasetDescription' => '

The description of the dataset.

', 'DisplayFormatOptions$BlankCellFormat' => '

Determines the blank cell format.

', 'DisplayFormatOptions$DateFormat' => '

Determines the DateTime format.

', 'DisplayFormatOptions$GroupingSeparator' => '

Determines the grouping separator.

', 'DisplayFormatOptions$Prefix' => '

The prefix value for a display format.

', 'DisplayFormatOptions$Suffix' => '

The suffix value for a display format.

', 'DisplayFormatOptions$CurrencySymbol' => '

The currency symbol, such as USD.

', 'Identifier$Identity' => '

The identity of the identifier.

', 'NamedEntityDefinition$FieldName' => '

The name of the entity.

', 'NamedEntityDefinition$PropertyName' => '

The property name to be used for the named entity.

', 'NamedEntityRef$NamedEntityName' => '

The NamedEntityName for the NamedEntityRef.

', 'NegativeFormat$Prefix' => '

The prefix for a negative format.

', 'NegativeFormat$Suffix' => '

The suffix for a negative format.

', 'RangeConstant$Minimum' => '

The minimum value for a range constant.

', 'RangeConstant$Maximum' => '

The maximum value for a range constant.

', 'SemanticEntityType$TypeName' => '

The semantic entity type name.

', 'SemanticEntityType$SubTypeName' => '

The semantic entity sub type name.

', 'SemanticType$TypeName' => '

The semantic type name.

', 'SemanticType$SubTypeName' => '

The semantic type sub type name.

', 'Slot$SlotId' => '

The slot ID of the slot.

', 'Slot$VisualId' => '

The visual ID for the slot.

', 'Synonyms$member' => NULL, 'TopicCalculatedField$CalculatedFieldName' => '

The calculated field name.

', 'TopicCalculatedField$CalculatedFieldDescription' => '

The calculated field description.

', 'TopicCategoryFilterConstant$SingularConstant' => '

A singular constant used in a category filter. This element is used to specify a single value for the constant.

', 'TopicColumn$ColumnName' => '

The name of the column.

', 'TopicColumn$ColumnFriendlyName' => '

A user-friendly name for the column.

', 'TopicColumn$ColumnDescription' => '

A description of the column and its contents.

', 'TopicDetails$Description' => '

The description of the topic.

', 'TopicFilter$FilterDescription' => '

A description of the filter used to select items for a topic.

', 'TopicFilter$FilterName' => '

The name of the filter.

', 'TopicFilter$OperandFieldName' => '

The name of the field that the filter operates on.

', 'TopicNamedEntity$EntityName' => '

The name of the named entity.

', 'TopicNamedEntity$EntityDescription' => '

The description of the named entity.

', 'TopicRefreshSchedule$Timezone' => '

The timezone that you want the refresh schedule to use.

', 'TopicRefreshSchedule$RepeatAt' => '

The time of day when the refresh should run, for example, Monday-Sunday.

', 'TopicRefreshScheduleSummary$DatasetId' => '

The ID of the dataset.

', 'TopicRefreshScheduleSummary$DatasetName' => '

The name of the dataset.

', 'TopicReviewedAnswer$Question' => '

The question for the TopicReviewedAnswer.

', 'TopicSingularFilterConstant$SingularConstant' => '

The value of the singular filter constant.

', 'TopicTemplate$TemplateType' => '

The template type for the TopicTemplate.

', 'TopicVisual$VisualId' => '

The visual ID for the TopicVisual.

', 'TypeParameters$key' => NULL, 'TypeParameters$value' => NULL, 'VisualOptions$type' => '

The type for a VisualOptions.

', ], ], 'LineChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a line chart.

', 'refs' => [ 'LineChartFieldWells$LineChartAggregatedFieldWells' => '

The field well configuration of a line chart.

', ], ], 'LineChartConfiguration' => [ 'base' => '

The configuration of a line chart.

', 'refs' => [ 'LineChartVisual$ChartConfiguration' => '

The configuration of a line chart.

', ], ], 'LineChartDefaultSeriesSettings' => [ 'base' => '

The options that determine the default presentation of all line series in LineChartVisual.

', 'refs' => [ 'LineChartConfiguration$DefaultSeriesSettings' => '

The options that determine the default presentation of all line series in LineChartVisual.

', ], ], 'LineChartFieldWells' => [ 'base' => '

The field well configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$FieldWells' => '

The field well configuration of a line chart.

', ], ], 'LineChartLineStyle' => [ 'base' => NULL, 'refs' => [ 'LineChartLineStyleSettings$LineStyle' => '

Line style for line series.

', ], ], 'LineChartLineStyleSettings' => [ 'base' => '

Line styles options for a line series in LineChartVisual.

', 'refs' => [ 'LineChartDefaultSeriesSettings$LineStyleSettings' => '

Line styles options for all line series in the visual.

', 'LineChartSeriesSettings$LineStyleSettings' => '

Line styles options for a line series in LineChartVisual.

', ], ], 'LineChartMarkerShape' => [ 'base' => NULL, 'refs' => [ 'LineChartMarkerStyleSettings$MarkerShape' => '

Shape option for markers in the series.

', ], ], 'LineChartMarkerStyleSettings' => [ 'base' => '

Marker styles options for a line series in LineChartVisual.

', 'refs' => [ 'LineChartDefaultSeriesSettings$MarkerStyleSettings' => '

Marker styles options for all line series in the visual.

', 'LineChartSeriesSettings$MarkerStyleSettings' => '

Marker styles options for a line series in LineChartVisual.

', ], ], 'LineChartSeriesSettings' => [ 'base' => '

The options that determine the presentation of a line series in the visual

', 'refs' => [ 'DataFieldSeriesItem$Settings' => '

The options that determine the presentation of line series associated to the field.

', 'FieldSeriesItem$Settings' => '

The options that determine the presentation of line series associated to the field.

', ], ], 'LineChartSortConfiguration' => [ 'base' => '

The sort configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$SortConfiguration' => '

The sort configuration of a line chart.

', ], ], 'LineChartType' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$Type' => '

Determines the type of the line chart.

', ], ], 'LineChartVisual' => [ 'base' => '

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$LineChartVisual' => '

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

', ], ], 'LineInterpolation' => [ 'base' => NULL, 'refs' => [ 'LineChartLineStyleSettings$LineInterpolation' => '

Interpolation style for line series.

', ], ], 'LineSeriesAxisDisplayOptions' => [ 'base' => '

The series axis configuration of a line chart.

', 'refs' => [ 'LineChartConfiguration$PrimaryYAxisDisplayOptions' => '

The series axis configuration of a line chart.

', 'LineChartConfiguration$SecondaryYAxisDisplayOptions' => '

The series axis configuration of a line chart.

', ], ], 'LinkEntityArn' => [ 'base' => NULL, 'refs' => [ 'LinkEntityArnList$member' => NULL, ], ], 'LinkEntityArnList' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'Dashboard$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'UpdateDashboardLinksRequest$LinkEntities' => '

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', 'UpdateDashboardLinksResponse$LinkEntities' => '

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

', ], ], 'LinkSharingConfiguration' => [ 'base' => '

A structure that contains the configuration of a shareable link to the dashboard.

', 'refs' => [ 'CreateDashboardRequest$LinkSharingConfiguration' => '

A structure that contains the permissions of a shareable link to the dashboard.

', 'DescribeDashboardPermissionsResponse$LinkSharingConfiguration' => '

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

', 'UpdateDashboardPermissionsResponse$LinkSharingConfiguration' => '

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

', ], ], 'ListAnalysesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalysesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssetBundleImportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultFilterListControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterListControl$DisplayOptions' => '

The display options of a control.

', 'ParameterListControl$DisplayOptions' => '

The display options of a control.

', ], ], 'ListControlSearchOptions' => [ 'base' => '

The configuration of the search options in a list control.

', 'refs' => [ 'ListControlDisplayOptions$SearchOptions' => '

The configuration of the search options in a list control.

', ], ], 'ListControlSelectAllOptions' => [ 'base' => '

The configuration of the Select all options in a list control.

', 'refs' => [ 'DropDownControlDisplayOptions$SelectAllOptions' => '

The configuration of the Select all options in a dropdown control.

', 'ListControlDisplayOptions$SelectAllOptions' => '

The configuration of the Select all options in a list control.

', ], ], 'ListDashboardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDashboardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFolderMembersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFolderMembersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFoldersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFoldersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsForUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsForUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIAMPolicyAssignmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIdentityPropagationMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListIdentityPropagationConfigsRequest$MaxResults' => '

The maximum number of results to be returned.

', ], ], 'ListIngestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNamespacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListNamespacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRefreshSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRefreshSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRoleMembershipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoleMembershipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplateVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemeVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListThemesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListThemesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicRefreshSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicRefreshSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicReviewedAnswersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicReviewedAnswersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadingAnimation' => [ 'base' => '

The configuration of loading animation in free-form layout.

', 'refs' => [ 'FreeFormLayoutElement$LoadingAnimation' => '

The loading animation configuration of a free-form layout element.

', ], ], 'LocalNavigationConfiguration' => [ 'base' => '

The navigation configuration for CustomActionNavigationOperation.

', 'refs' => [ 'CustomActionNavigationOperation$LocalNavigationConfiguration' => '

The configuration that chooses the navigation target.

', ], ], 'LogicalTable' => [ 'base' => '

A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

', 'refs' => [ 'LogicalTableMap$value' => NULL, ], ], 'LogicalTableAlias' => [ 'base' => NULL, 'refs' => [ 'LogicalTable$Alias' => '

A display name for the logical table.

', ], ], 'LogicalTableId' => [ 'base' => '

An identifier for the logical table that is defined in the dataset

', 'refs' => [ 'JoinInstruction$LeftOperand' => '

The operand on the left side of a join.

', 'JoinInstruction$RightOperand' => '

The operand on the right side of a join.

', 'LogicalTableMap$key' => NULL, ], ], 'LogicalTableMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', 'DataSet$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', 'UpdateDataSetRequest$LogicalTableMap' => '

Configures the combination and transformation of the data from the physical tables.

', ], ], 'LogicalTableSource' => [ 'base' => '

Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'LogicalTable$Source' => '

Source of this logical table.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'DataSet$ConsumedSpiceCapacityInBytes' => '

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn\'t imported into SPICE.

', 'Ingestion$IngestionTimeInSeconds' => '

The time that this ingestion took, measured in seconds.

', 'Ingestion$IngestionSizeInBytes' => '

The size of the data ingested, in bytes.

', 'ItemsLimitConfiguration$ItemsLimit' => '

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

', 'PaginationConfiguration$PageSize' => '

Indicates how many items render in one page.

', 'RowInfo$RowsIngested' => '

The number of rows that were ingested.

', 'RowInfo$RowsDropped' => '

The number of rows that were not ingested.

', 'RowInfo$TotalRowsInDataset' => '

The total number of rows in the dataset.

', ], ], 'LongFormatText' => [ 'base' => '

The text format for a subtitle.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualSubtitleLabelOptions$FormatText' => '

The long text format of the subtitle label, such as plain text or rich text.

', ], ], 'LongPlainText' => [ 'base' => NULL, 'refs' => [ 'LongFormatText$PlainText' => '

Plain text format.

', ], ], 'LongRichText' => [ 'base' => NULL, 'refs' => [ 'LongFormatText$RichText' => '

Rich text. Examples of rich text include bold, underline, and italics.

', ], ], 'Longitude' => [ 'base' => NULL, 'refs' => [ 'GeospatialCoordinateBounds$West' => '

The longitude of the west bound of the geospatial coordinate bounds.

', 'GeospatialCoordinateBounds$East' => '

The longitude of the east bound of the geospatial coordinate bounds.

', ], ], 'LookbackWindow' => [ 'base' => '

The lookback window setup of an incremental refresh configuration.

', 'refs' => [ 'IncrementalRefresh$LookbackWindow' => '

The lookback window setup for an incremental refresh configuration.

', ], ], 'LookbackWindowSizeUnit' => [ 'base' => NULL, 'refs' => [ 'LookbackWindow$SizeUnit' => '

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

', ], ], 'ManifestFileLocation' => [ 'base' => '

Amazon S3 manifest file location.

', 'refs' => [ 'S3Parameters$ManifestFileLocation' => '

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

', ], ], 'MapZoomMode' => [ 'base' => NULL, 'refs' => [ 'GeospatialWindowOptions$MapZoomMode' => '

The map zoom modes (manual, auto) of the geospatial window options.

', ], ], 'MappedDataSetParameter' => [ 'base' => '

A dataset parameter that is mapped to an analysis parameter.

', 'refs' => [ 'MappedDataSetParameters$member' => NULL, ], ], 'MappedDataSetParameters' => [ 'base' => '

A list of dataset parameters that are mapped to an analysis parameter.

', 'refs' => [ 'DateTimeParameterDeclaration$MappedDataSetParameters' => NULL, 'DecimalParameterDeclaration$MappedDataSetParameters' => NULL, 'IntegerParameterDeclaration$MappedDataSetParameters' => NULL, 'StringParameterDeclaration$MappedDataSetParameters' => NULL, ], ], 'MarginStyle' => [ 'base' => '

The display options for margins around the outside edge of sheets.

', 'refs' => [ 'TileLayoutStyle$Margin' => '

The margin settings that apply around the outside edge of sheets.

', ], ], 'MariaDbParameters' => [ 'base' => '

The parameters for MariaDB.

', 'refs' => [ 'DataSourceParameters$MariaDbParameters' => '

The parameters for MariaDB.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeFolderPermissionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'DescribeFolderResolvedPermissionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListAnalysesRequest$MaxResults' => '

The maximum number of results to return.

', 'ListAssetBundleExportJobsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListAssetBundleImportJobsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDashboardVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDashboardsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDataSetsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListDataSourcesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListFolderMembersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListFoldersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListGroupMembershipsRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListGroupsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListIAMPolicyAssignmentsForUserRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListIAMPolicyAssignmentsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListNamespacesRequest$MaxResults' => '

The maximum number of results to return.

', 'ListRoleMembershipsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListTemplateAliasesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTemplateVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTemplatesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemeAliasesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemeVersionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListThemesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListTopicsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'ListUserGroupsRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListUsersRequest$MaxResults' => '

The maximum number of results to return from this request.

', 'ListVPCConnectionsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchAnalysesRequest$MaxResults' => '

The maximum number of results to return.

', 'SearchDashboardsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchDataSetsRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchDataSourcesRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchFoldersRequest$MaxResults' => '

The maximum number of results to be returned per request.

', 'SearchGroupsRequest$MaxResults' => '

The maximum number of results to return from this request.

', ], ], 'MaximumLabelType' => [ 'base' => '

The maximum label of a data path label.

', 'refs' => [ 'DataLabelType$MaximumLabelType' => '

Determines the label configuration for the maximum value in a visual.

', ], ], 'MaximumMinimumComputation' => [ 'base' => '

The maximum and minimum computation configuration.

', 'refs' => [ 'Computation$MaximumMinimum' => '

The maximum and minimum computation configuration.

', ], ], 'MaximumMinimumComputationType' => [ 'base' => NULL, 'refs' => [ 'MaximumMinimumComputation$Type' => '

The type of computation. Choose one of the following options:

', ], ], 'MeasureField' => [ 'base' => '

The measure (metric) type field.

', 'refs' => [ 'BoxPlotMeasureFieldList$member' => NULL, 'FilledMapMeasureFieldList$member' => NULL, 'ForecastComputation$Value' => '

The value field that is used in a computation.

', 'FunnelChartMeasureFieldList$member' => NULL, 'GrowthRateComputation$Value' => '

The value field that is used in a computation.

', 'HeatMapMeasureFieldList$member' => NULL, 'HistogramMeasureFieldList$member' => NULL, 'MaximumMinimumComputation$Value' => '

The value field that is used in a computation.

', 'MeasureFieldList$member' => NULL, 'MetricComparisonComputation$FromValue' => '

The field that is used in a metric comparison from value setup.

', 'MetricComparisonComputation$TargetValue' => '

The field that is used in a metric comparison to value setup.

', 'PeriodOverPeriodComputation$Value' => '

The value field that is used in a computation.

', 'PeriodToDateComputation$Value' => '

The value field that is used in a computation.

', 'PivotMeasureFieldList$member' => NULL, 'RadarChartValuesFieldList$member' => NULL, 'TopBottomMoversComputation$Value' => '

The value field that is used in a computation.

', 'TopBottomRankedComputation$Value' => '

The value field that is used in a computation.

', 'TotalAggregationComputation$Value' => '

The value field that is used in a computation.

', 'TreeMapMeasureFieldList$member' => NULL, 'WordCloudMeasureFieldList$member' => NULL, ], ], 'MeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$Values' => '

The value field wells of a bar chart. Values are aggregated by category.

', 'ComboChartAggregatedFieldWells$BarValues' => '

The aggregated BarValues field well of a combo chart.

', 'ComboChartAggregatedFieldWells$LineValues' => '

The aggregated LineValues field well of a combo chart.

', 'GaugeChartFieldWells$Values' => '

The value field wells of a GaugeChartVisual.

', 'GaugeChartFieldWells$TargetValues' => '

The target value field wells of a GaugeChartVisual.

', 'GeospatialMapAggregatedFieldWells$Values' => '

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

', 'KPIFieldWells$Values' => '

The value field wells of a KPI visual.

', 'KPIFieldWells$TargetValues' => '

The target value field wells of a KPI visual.

', 'LineChartAggregatedFieldWells$Values' => '

The value field wells of a line chart. Values are aggregated based on categories.

', 'PieChartAggregatedFieldWells$Values' => '

The value field wells of a pie chart. Values are aggregated based on categories.

', 'SankeyDiagramAggregatedFieldWells$Weight' => '

The weight field wells of a sankey diagram.

', 'ScatterPlotCategoricallyAggregatedFieldWells$XAxis' => '

The x-axis field well of a scatter plot.

The x-axis is aggregated by category.

', 'ScatterPlotCategoricallyAggregatedFieldWells$YAxis' => '

The y-axis field well of a scatter plot.

The y-axis is aggregated by category.

', 'ScatterPlotCategoricallyAggregatedFieldWells$Size' => '

The size field well of a scatter plot.

', 'ScatterPlotUnaggregatedFieldWells$Size' => '

The size field well of a scatter plot.

', 'TableAggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are aggregated based on group by fields.

', 'WaterfallChartAggregatedFieldWells$Values' => '

The value field wells of a waterfall visual.

', ], ], 'MemberIdArnPair' => [ 'base' => '

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

', 'refs' => [ 'FolderMemberList$member' => NULL, ], ], 'MemberType' => [ 'base' => NULL, 'refs' => [ 'CreateFolderMembershipRequest$MemberType' => '

The member type of the asset that you want to add to a folder.

', 'DeleteFolderMembershipRequest$MemberType' => '

The member type of the asset that you want to delete from a folder.

', 'FolderMember$MemberType' => '

The type of asset that it is.

', ], ], 'MetricComparisonComputation' => [ 'base' => '

The metric comparison computation configuration.

', 'refs' => [ 'Computation$MetricComparison' => '

The metric comparison computation configuration.

', ], ], 'MinimumLabelType' => [ 'base' => '

The minimum label of a data path label.

', 'refs' => [ 'DataLabelType$MinimumLabelType' => '

Determines the label configuration for the minimum value in a visual.

', ], ], 'MissingDataConfiguration' => [ 'base' => '

The configuration options that determine how missing data is treated during the rendering of a line chart.

', 'refs' => [ 'MissingDataConfigurationList$member' => NULL, ], ], 'MissingDataConfigurationList' => [ 'base' => NULL, 'refs' => [ 'LineSeriesAxisDisplayOptions$MissingDataConfigurations' => '

The configuration options that determine how missing data is treated during the rendering of a line chart.

', ], ], 'MissingDataTreatmentOption' => [ 'base' => NULL, 'refs' => [ 'MissingDataConfiguration$TreatmentOption' => '

The treatment option that determines how missing data should be rendered. Choose from the following options:

', ], ], 'MySqlParameters' => [ 'base' => '

The parameters for MySQL.

', 'refs' => [ 'DataSourceParameters$MySqlParameters' => '

The parameters for MySQL.

', ], ], 'NamedEntityAggType' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinitionMetric$Aggregation' => '

The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

', ], ], 'NamedEntityDefinition' => [ 'base' => '

A structure that represents a named entity.

', 'refs' => [ 'NamedEntityDefinitions$member' => NULL, ], ], 'NamedEntityDefinitionMetric' => [ 'base' => '

A structure that represents a metric.

', 'refs' => [ 'NamedEntityDefinition$Metric' => '

The definition of a metric.

', ], ], 'NamedEntityDefinitions' => [ 'base' => NULL, 'refs' => [ 'TopicNamedEntity$Definition' => '

The definition of a named entity.

', ], ], 'NamedEntityRef' => [ 'base' => '

The definition for a NamedEntityRef.

', 'refs' => [ 'TopicIRGroupBy$NamedEntity' => '

The named entity for the TopicIRGroupBy.

', 'TopicIRMetric$NamedEntity' => '

The named entity for the TopicIRMetric.

', ], ], 'NamedFilterAggType' => [ 'base' => NULL, 'refs' => [ 'TopicNumericEqualityFilter$Aggregation' => '

An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

', 'TopicNumericRangeFilter$Aggregation' => '

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

', ], ], 'NamedFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicFilter$FilterType' => '

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

', ], ], 'Namespace' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$DefaultNamespace' => '

The default Amazon QuickSight namespace for your Amazon Web Services account.

', 'CreateAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you want to add customizations to.

', 'CreateAccountCustomizationResponse$Namespace' => '

The namespace associated with the customization you\'re creating.

', 'CreateGroupMembershipRequest$Namespace' => '

The namespace that you want the user to be a part of.

', 'CreateGroupRequest$Namespace' => '

The namespace that you want the group to be a part of.

', 'CreateIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'CreateNamespaceRequest$Namespace' => '

The name that you want to use to describe the new namespace.

', 'CreateNamespaceResponse$Name' => '

The name of the new namespace that you created.

', 'CreateRoleMembershipRequest$Namespace' => '

The namespace that the role belongs to.

', 'DeleteAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you\'re deleting the customizations from.

', 'DeleteGroupMembershipRequest$Namespace' => '

The namespace of the group that you want to remove a user from.

', 'DeleteGroupRequest$Namespace' => '

The namespace of the group that you want to delete.

', 'DeleteIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'DeleteNamespaceRequest$Namespace' => '

The namespace that you want to delete.

', 'DeleteRoleCustomPermissionRequest$Namespace' => '

The namespace that includes the role.

', 'DeleteRoleMembershipRequest$Namespace' => '

The namespace that contains the role.

', 'DeleteUserByPrincipalIdRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'DeleteUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'DescribeAccountCustomizationRequest$Namespace' => '

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

', 'DescribeAccountCustomizationResponse$Namespace' => '

The Amazon QuickSight namespace that you\'re describing.

', 'DescribeFolderPermissionsRequest$Namespace' => '

The namespace of the folder whose permissions you want described.

', 'DescribeFolderResolvedPermissionsRequest$Namespace' => '

The namespace of the folder whose permissions you want described.

', 'DescribeGroupMembershipRequest$Namespace' => '

The namespace that includes the group you are searching within.

', 'DescribeGroupRequest$Namespace' => '

The namespace of the group that you want described.

', 'DescribeIAMPolicyAssignmentRequest$Namespace' => '

The namespace that contains the assignment.

', 'DescribeNamespaceRequest$Namespace' => '

The namespace that you want to describe.

', 'DescribeRoleCustomPermissionRequest$Namespace' => '

The namespace that contains the role.

', 'DescribeUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'GenerateEmbedUrlForAnonymousUserRequest$Namespace' => '

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.

', 'GetDashboardEmbedUrlRequest$Namespace' => '

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you\'re not using a custom namespace, set Namespace = default.

', 'ListGroupMembershipsRequest$Namespace' => '

The namespace of the group that you want a list of users from.

', 'ListGroupsRequest$Namespace' => '

The namespace that you want a list of groups from.

', 'ListIAMPolicyAssignmentsForUserRequest$Namespace' => '

The namespace of the assignment.

', 'ListIAMPolicyAssignmentsRequest$Namespace' => '

The namespace for the assignments.

', 'ListRoleMembershipsRequest$Namespace' => '

The namespace that includes the role.

', 'ListUserGroupsRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'ListUsersRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'NamespaceInfoV2$Name' => '

The name of the error.

', 'RegisterUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', 'RowLevelPermissionDataSet$Namespace' => '

The namespace associated with the dataset that contains permissions for RLS.

', 'SearchGroupsRequest$Namespace' => '

The namespace that you want to search.

', 'UpdateAccountCustomizationRequest$Namespace' => '

The namespace that you want to update Amazon QuickSight customizations for.

', 'UpdateAccountCustomizationResponse$Namespace' => '

The namespace associated with the customization that you\'re updating.

', 'UpdateAccountSettingsRequest$DefaultNamespace' => '

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.

', 'UpdateGroupRequest$Namespace' => '

The namespace of the group that you want to update.

', 'UpdateIAMPolicyAssignmentRequest$Namespace' => '

The namespace of the assignment.

', 'UpdateRoleCustomPermissionRequest$Namespace' => '

The namespace that contains the role that you want to update.

', 'UpdateUserRequest$Namespace' => '

The namespace. Currently, you should set this to default.

', ], ], 'NamespaceError' => [ 'base' => '

Errors that occur during namespace creation.

', 'refs' => [ 'NamespaceInfoV2$NamespaceError' => '

An error that occurred when the namespace was created.

', ], ], 'NamespaceErrorType' => [ 'base' => NULL, 'refs' => [ 'NamespaceError$Type' => '

The error type.

', ], ], 'NamespaceInfoV2' => [ 'base' => '

The error type.

', 'refs' => [ 'DescribeNamespaceResponse$Namespace' => '

The information about the namespace that you\'re describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

', 'Namespaces$member' => NULL, ], ], 'NamespaceStatus' => [ 'base' => NULL, 'refs' => [ 'CreateNamespaceResponse$CreationStatus' => '

The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

', 'NamespaceInfoV2$CreationStatus' => '

The creation status of a namespace that is not yet completely created.

', ], ], 'Namespaces' => [ 'base' => NULL, 'refs' => [ 'ListNamespacesResponse$Namespaces' => '

The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.

', ], ], 'NarrativeString' => [ 'base' => NULL, 'refs' => [ 'CustomNarrativeOptions$Narrative' => '

The string input of custom narrative.

', ], ], 'NegativeFormat' => [ 'base' => '

A structure that represents a negative format.

', 'refs' => [ 'DisplayFormatOptions$NegativeFormat' => '

The negative format.

', ], ], 'NegativeValueConfiguration' => [ 'base' => '

The options that determine the negative value configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', 'NumberDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', 'PercentageDisplayFormatConfiguration$NegativeValueConfiguration' => '

The options that determine the negative value configuration.

', ], ], 'NegativeValueDisplayMode' => [ 'base' => NULL, 'refs' => [ 'NegativeValueConfiguration$DisplayMode' => '

Determines the display mode of the negative value configuration.

', ], ], 'NestedFilter' => [ 'base' => '

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

', 'refs' => [ 'Filter$NestedFilter' => '

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

', ], ], 'NetworkInterface' => [ 'base' => '

The structure that contains information about a network interface.

', 'refs' => [ 'NetworkInterfaceList$member' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$NetworkInterfaceId' => '

The network interface ID.

', ], ], 'NetworkInterfaceList' => [ 'base' => NULL, 'refs' => [ 'VPCConnection$NetworkInterfaces' => '

A list of network interfaces.

', 'VPCConnectionSummary$NetworkInterfaces' => '

A list of network interfaces.

', ], ], 'NetworkInterfaceStatus' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$Status' => '

The status of the network interface.

', ], ], 'NewDefaultValues' => [ 'base' => '

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

', 'refs' => [ 'OverrideDatasetParameterOperation$NewDefaultValues' => '

The new default values for the parameter.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AnalysisError$Message' => '

The message associated with the analysis error.

', 'AssetBundleExportJobError$Type' => '

The specific error type of the error that occurred.

', 'AssetBundleExportJobError$Message' => '

A description of the error.

', 'AssetBundleExportJobWarning$Message' => '

A description of the warning.

', 'AssetBundleImportJobError$Type' => '

The specific error type or the error that occurred.

', 'AssetBundleImportJobError$Message' => '

A description of the error.

', 'AssetBundleImportJobWarning$Message' => '

A description of the warning that occurred during an Asset Bundle import job.

', 'DashboardError$Message' => '

Message.

', 'DataSetReference$DataSetPlaceholder' => '

Dataset placeholder.

', 'DateTimeParameter$Name' => '

A display name for the date-time parameter.

', 'DecimalParameter$Name' => '

A display name for the decimal parameter.

', 'DescribeAssetBundleExportJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAssetBundleImportJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardSnapshotJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardSnapshotJobResultResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeKeyRegistrationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'Entity$Path' => '

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

', 'FailedKeyRegistrationEntry$Message' => '

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

', 'IntegerParameter$Name' => '

The name of the integer parameter.

', 'ListAssetBundleExportJobsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListAssetBundleImportJobsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ReferenceLineCustomLabelConfiguration$CustomLabel' => '

The string text of the custom label.

', 'S3BucketConfiguration$BucketName' => '

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

', 'S3BucketConfiguration$BucketPrefix' => '

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

', 'S3BucketConfiguration$BucketRegion' => '

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.

', 'StartAssetBundleExportJobResponse$RequestId' => '

The Amazon Web Services response ID for this operation.

', 'StartAssetBundleImportJobResponse$RequestId' => '

The Amazon Web Services response ID for this operation.

', 'StartDashboardSnapshotJobResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'StringParameter$Name' => '

A display name for a string parameter.

', 'TemplateError$Message' => '

Description of the error type.

', 'ThemeError$Message' => '

The error message.

', 'UpdateKeyRegistrationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', ], ], 'NonRepeatingVisualsList' => [ 'base' => NULL, 'refs' => [ 'BodySectionRepeatConfiguration$NonRepeatingVisuals' => '

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

', ], ], 'NullFilterOption' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$NullFilter' => '

The null filter for the TopicIRFilterOption.

', ], ], 'NullString' => [ 'base' => NULL, 'refs' => [ 'NullValueFormatConfiguration$NullString' => '

Determines the null string of null values.

', ], ], 'NullValueFormatConfiguration' => [ 'base' => '

The options that determine the null value format configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'DateTimeFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'NumberDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'PercentageDisplayFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', 'StringFormatConfiguration$NullValueFormatConfiguration' => '

The options that determine the null value format configuration.

', ], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$Enabled' => '

A value that specifies whether IP rules are turned on.

', 'TopicCalculatedField$DisableIndexing' => '

A Boolean value that indicates if a calculated field is visible in the autocomplete.

', 'TopicCalculatedField$NonAdditive' => '

The non additive for the table style target.

', 'TopicColumn$DisableIndexing' => '

A Boolean value that indicates whether the column shows in the autocomplete functionality.

', 'TopicColumn$NonAdditive' => '

The non additive value for the column.

', 'TopicRefreshSchedule$IsEnabled' => '

A Boolean value that controls whether to schedule is enabled.

', 'UpdateIpRestrictionRequest$Enabled' => '

A value that specifies whether IP rules are turned on.

', ], ], 'NumberDisplayFormatConfiguration' => [ 'base' => '

The options that determine the number display format configuration.

', 'refs' => [ 'ComparisonFormatConfiguration$NumberDisplayFormatConfiguration' => '

The number display format.

', 'NumericFormatConfiguration$NumberDisplayFormatConfiguration' => '

The options that determine the number display format configuration.

', ], ], 'NumberFormatConfiguration' => [ 'base' => '

Formatting configuration for number fields.

', 'refs' => [ 'FormatConfiguration$NumberFormatConfiguration' => '

Formatting configuration for number fields.

', 'NumericalDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'NumericalMeasureField$FormatConfiguration' => '

The format configuration of the field.

', ], ], 'NumberScale' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$NumberScale' => '

Determines the number scale value for the currency format.

', 'DisplayFormatOptions$UnitScaler' => '

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

', 'NumberDisplayFormatConfiguration$NumberScale' => '

Determines the number scale value of the number format.

', ], ], 'NumericAxisOptions' => [ 'base' => '

The options for an axis with a numeric field.

', 'refs' => [ 'AxisDataOptions$NumericAxisOptions' => '

The options for an axis with a numeric field.

', ], ], 'NumericEqualityDrillDownFilter' => [ 'base' => '

The numeric equality type drill down filter.

', 'refs' => [ 'DrillDownFilter$NumericEqualityFilter' => '

The numeric equality type drill down filter. This filter is used for number type columns.

', ], ], 'NumericEqualityFilter' => [ 'base' => '

A NumericEqualityFilter filters values that are equal to the specified value.

', 'refs' => [ 'Filter$NumericEqualityFilter' => '

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

', ], ], 'NumericEqualityMatchOperator' => [ 'base' => NULL, 'refs' => [ 'NumericEqualityFilter$MatchOperator' => '

The match operator that is used to determine if a filter should be applied.

', ], ], 'NumericFilterSelectAllOptions' => [ 'base' => NULL, 'refs' => [ 'NumericEqualityFilter$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', 'NumericRangeFilter$SelectAllOptions' => '

Select all of the values. Null is not the assigned value of select all.

', ], ], 'NumericFormatConfiguration' => [ 'base' => '

The options that determine the numeric format configuration.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'DateTimeFormatConfiguration$NumericFormatConfiguration' => '

The formatting configuration for numeric DateTime fields.

', 'NumberFormatConfiguration$FormatConfiguration' => '

The options that determine the numeric format configuration.

', 'ReferenceLineValueLabelConfiguration$FormatConfiguration' => '

The format configuration of the value label.

', 'StringFormatConfiguration$NumericFormatConfiguration' => '

The formatting configuration for numeric strings.

', ], ], 'NumericRangeFilter' => [ 'base' => '

A NumericRangeFilter filters values that are within the value range.

', 'refs' => [ 'Filter$NumericRangeFilter' => '

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

', ], ], 'NumericRangeFilterValue' => [ 'base' => '

The value input pf the numeric range filter.

', 'refs' => [ 'NumericRangeFilter$RangeMinimum' => '

The minimum value for the filter value range.

', 'NumericRangeFilter$RangeMaximum' => '

The maximum value for the filter value range.

', ], ], 'NumericSeparatorConfiguration' => [ 'base' => '

The options that determine the numeric separator configuration.

', 'refs' => [ 'CurrencyDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', 'NumberDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', 'PercentageDisplayFormatConfiguration$SeparatorConfiguration' => '

The options that determine the numeric separator configuration.

', ], ], 'NumericSeparatorSymbol' => [ 'base' => NULL, 'refs' => [ 'NumericSeparatorConfiguration$DecimalSeparator' => '

Determines the decimal separator.

', 'ThousandSeparatorOptions$Symbol' => '

Determines the thousands separator symbol.

', ], ], 'NumericalAggregationFunction' => [ 'base' => '

Aggregation for numerical values.

', 'refs' => [ 'AggregationFunction$NumericalAggregationFunction' => '

Aggregation for numerical values.

', 'NumericalMeasureField$AggregationFunction' => '

The aggregation function of the measure field.

', 'ReferenceLineDynamicDataConfiguration$Calculation' => '

The calculation that is used in the dynamic data.

', ], ], 'NumericalDimensionField' => [ 'base' => '

The dimension type field with numerical type columns.

', 'refs' => [ 'DimensionField$NumericalDimensionField' => '

The dimension type field with numerical type columns.

', ], ], 'NumericalMeasureField' => [ 'base' => '

The measure type field with numerical type columns.

', 'refs' => [ 'MeasureField$NumericalMeasureField' => '

The measure type field with numerical type columns.

', ], ], 'OnClause' => [ 'base' => NULL, 'refs' => [ 'JoinInstruction$OnClause' => '

The join instructions provided in the ON clause of a join.

', ], ], 'OperandList' => [ 'base' => NULL, 'refs' => [ 'TopicIRMetric$Operands' => '

The operands for the TopicIRMetric.

', ], ], 'OptionalPort' => [ 'base' => NULL, 'refs' => [ 'RedshiftParameters$Port' => '

Port. This field can be blank if the ClusterId is provided.

', ], ], 'OracleParameters' => [ 'base' => '

The parameters for Oracle.

', 'refs' => [ 'DataSourceParameters$OracleParameters' => '

The parameters for Oracle.

', ], ], 'OtherCategories' => [ 'base' => NULL, 'refs' => [ 'ItemsLimitConfiguration$OtherCategories' => '

The Show other of an axis in the chart. Choose one of the following options:

', ], ], 'OutputColumn' => [ 'base' => '

Output column.

', 'refs' => [ 'OutputColumnList$member' => NULL, ], ], 'OutputColumnList' => [ 'base' => NULL, 'refs' => [ 'DataSet$OutputColumns' => '

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

', ], ], 'OverrideDatasetParameterOperation' => [ 'base' => '

A transform operation that overrides the dataset parameter values that are defined in another dataset.

', 'refs' => [ 'TransformOperation$OverrideDatasetParameterOperation' => NULL, ], ], 'PageNumber' => [ 'base' => NULL, 'refs' => [ 'PaginationConfiguration$PageNumber' => '

Indicates the page number.

', ], ], 'PaginationConfiguration' => [ 'base' => '

The pagination configuration for a table visual or boxplot.

', 'refs' => [ 'BoxPlotSortConfiguration$PaginationConfiguration' => '

The pagination configuration of a table visual or box plot.

', 'TableSortConfiguration$PaginationConfiguration' => '

The pagination configuration (page size, page number) for the table.

', ], ], 'PanelBorderStyle' => [ 'base' => NULL, 'refs' => [ 'PanelConfiguration$BorderStyle' => '

Sets the line style of panel borders.

', ], ], 'PanelConfiguration' => [ 'base' => '

A collection of options that configure how each panel displays in a small multiples chart.

', 'refs' => [ 'SmallMultiplesOptions$PanelConfiguration' => '

Configures the display options for each small multiples panel.

', ], ], 'PanelTitleOptions' => [ 'base' => '

The options that determine the title styles for each small multiples panel.

', 'refs' => [ 'PanelConfiguration$Title' => '

Configures the title display within each small multiples panel.

', ], ], 'PaperOrientation' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperOrientation' => '

The paper orientation that is used to define canvas dimensions. Choose one of the following options:

', ], ], 'PaperSize' => [ 'base' => NULL, 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperSize' => '

The paper size that is used to define canvas dimensions.

', ], ], 'ParameterControl' => [ 'base' => '

The control of a parameter that users can interact with in a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ParameterControlList$member' => NULL, ], ], 'ParameterControlList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$ParameterControls' => '

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

', ], ], 'ParameterDateTimePickerControl' => [ 'base' => '

A control from a date parameter that specifies date and time.

', 'refs' => [ 'ParameterControl$DateTimePicker' => '

A control from a date parameter that specifies date and time.

', ], ], 'ParameterDeclaration' => [ 'base' => '

The declaration definition of a parameter.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ParameterDeclarationList$member' => NULL, ], ], 'ParameterDeclarationList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$ParameterDeclarations' => '

An array of parameter declarations for an analysis.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'DashboardVersionDefinition$ParameterDeclarations' => '

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'TemplateVersionDefinition$ParameterDeclarations' => '

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

', ], ], 'ParameterDropDownControl' => [ 'base' => '

A control to display a dropdown list with buttons that are used to select a single value.

', 'refs' => [ 'ParameterControl$Dropdown' => '

A control to display a dropdown list with buttons that are used to select a single value.

', ], ], 'ParameterListControl' => [ 'base' => '

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

', 'refs' => [ 'ParameterControl$List' => '

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'AnchorDateConfiguration$ParameterName' => '

The name of the parameter that is used for the anchor date configuration.

', 'CustomFilterConfiguration$ParameterName' => '

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue.

', 'DateTimeParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'DecimalParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'IntegerParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'MappedDataSetParameter$DataSetParameterName' => '

The name of the dataset parameter.

', 'NumericEqualityFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', 'NumericRangeFilterValue$Parameter' => '

The parameter that is used in the numeric range.

', 'ParameterDateTimePickerControl$SourceParameterName' => '

The name of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$SourceParameterName' => '

The source parameter name of the ParameterDropDownControl.

', 'ParameterListControl$SourceParameterName' => '

The source parameter name of the ParameterListControl.

', 'ParameterSliderControl$SourceParameterName' => '

The source parameter name of the ParameterSliderControl.

', 'ParameterTextAreaControl$SourceParameterName' => '

The source parameter name of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$SourceParameterName' => '

The source parameter name of the ParameterTextFieldControl.

', 'RelativeDatesFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', 'SetParameterValueConfiguration$DestinationParameterName' => '

The destination parameter name of the SetParameterValueConfiguration.

', 'StringParameterDeclaration$Name' => '

The name of the parameter that is being declared.

', 'TimeEqualityFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value and RollingDate.

', 'TimeRangeFilterValue$Parameter' => '

The parameter type input value.

', 'TopBottomFilter$ParameterName' => '

The parameter whose value should be used for the filter value.

', ], ], 'ParameterSelectableValueList' => [ 'base' => NULL, 'refs' => [ 'FilterSelectableValues$Values' => '

The values that are used in the FilterSelectableValues.

', 'ParameterSelectableValues$Values' => '

The values that are used in ParameterSelectableValues.

', ], ], 'ParameterSelectableValues' => [ 'base' => '

A list of selectable values that are used in a control.

', 'refs' => [ 'ParameterDropDownControl$SelectableValues' => '

A list of selectable values that are used in a control.

', 'ParameterListControl$SelectableValues' => '

A list of selectable values that are used in a control.

', ], ], 'ParameterSliderControl' => [ 'base' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', 'refs' => [ 'ParameterControl$Slider' => '

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

', ], ], 'ParameterTextAreaControl' => [ 'base' => '

A control to display a text box that is used to enter multiple entries.

', 'refs' => [ 'ParameterControl$TextArea' => '

A control to display a text box that is used to enter multiple entries.

', ], ], 'ParameterTextFieldControl' => [ 'base' => '

A control to display a text box that is used to enter a single entry.

', 'refs' => [ 'ParameterControl$TextField' => '

A control to display a text box that is used to enter a single entry.

', ], ], 'ParameterValueType' => [ 'base' => NULL, 'refs' => [ 'DecimalParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', 'IntegerParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', 'StringParameterDeclaration$ParameterValueType' => '

The value type determines whether the parameter is a single-value or multi-value parameter.

', ], ], 'Parameters' => [ 'base' => '

A list of Amazon QuickSight parameters and the list\'s override values.

', 'refs' => [ 'CreateAnalysisRequest$Parameters' => '

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

', 'CreateDashboardRequest$Parameters' => '

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

', 'SnapshotConfiguration$Parameters' => NULL, 'UpdateAnalysisRequest$Parameters' => '

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

', 'UpdateDashboardRequest$Parameters' => '

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentialPair$Password' => '

The password for the data source connection.

', 'CredentialPair$Password' => '

Password.

', ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'Folder$FolderPath' => '

An array of ancestor ARN strings for the folder.

', ], ], 'PercentNumber' => [ 'base' => NULL, 'refs' => [ 'PercentVisibleRange$From' => '

The lower bound of the range.

', 'PercentVisibleRange$To' => '

The top bound of the range.

', ], ], 'PercentVisibleRange' => [ 'base' => '

The percent range in the visible range.

', 'refs' => [ 'VisibleRangeOptions$PercentRange' => '

The percent range in the visible range.

', ], ], 'PercentageDisplayFormatConfiguration' => [ 'base' => '

The options that determine the percentage display format configuration.

', 'refs' => [ 'ComparisonFormatConfiguration$PercentageDisplayFormatConfiguration' => '

The percentage display format.

', 'NumericFormatConfiguration$PercentageDisplayFormatConfiguration' => '

The options that determine the percentage display format configuration.

', ], ], 'PercentileAggregation' => [ 'base' => '

An aggregation based on the percentile of values in a dimension or measure.

', 'refs' => [ 'NumericalAggregationFunction$PercentileAggregation' => '

An aggregation based on the percentile of values in a dimension or measure.

', ], ], 'PercentileValue' => [ 'base' => NULL, 'refs' => [ 'PercentileAggregation$PercentileValue' => '

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

', ], ], 'PeriodOverPeriodComputation' => [ 'base' => '

The period over period computation configuration.

', 'refs' => [ 'Computation$PeriodOverPeriod' => '

The period over period computation configuration.

', ], ], 'PeriodToDateComputation' => [ 'base' => '

The period to date computation configuration.

', 'refs' => [ 'Computation$PeriodToDate' => '

The period to DataSetIdentifier computation configuration.

', ], ], 'PeriodsBackward' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PeriodsBackward' => '

The periods backward setup of a forecast computation.

', 'TimeBasedForecastProperties$PeriodsBackward' => '

The periods backward setup of a forecast computation.

', ], ], 'PeriodsForward' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PeriodsForward' => '

The periods forward setup of a forecast computation.

', 'TimeBasedForecastProperties$PeriodsForward' => '

The periods forward setup of a forecast computation.

', ], ], 'PhysicalTable' => [ 'base' => '

A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'PhysicalTableMap$value' => NULL, ], ], 'PhysicalTableId' => [ 'base' => NULL, 'refs' => [ 'LogicalTableSource$PhysicalTableId' => '

Physical table ID.

', 'PhysicalTableMap$key' => NULL, ], ], 'PhysicalTableMap' => [ 'base' => NULL, 'refs' => [ 'CreateDataSetRequest$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', 'DataSet$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', 'UpdateDataSetRequest$PhysicalTableMap' => '

Declares the physical tables that are available in the underlying data sources.

', ], ], 'PieChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a pie chart.

', 'refs' => [ 'PieChartFieldWells$PieChartAggregatedFieldWells' => '

The field well configuration of a pie chart.

', ], ], 'PieChartConfiguration' => [ 'base' => '

The configuration of a pie chart.

', 'refs' => [ 'PieChartVisual$ChartConfiguration' => '

The configuration of a pie chart.

', ], ], 'PieChartFieldWells' => [ 'base' => '

The field well configuration of a pie chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'PieChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'PieChartSortConfiguration' => [ 'base' => '

The sort configuration of a pie chart.

', 'refs' => [ 'PieChartConfiguration$SortConfiguration' => '

The sort configuration of a pie chart.

', ], ], 'PieChartVisual' => [ 'base' => '

A pie or donut chart.

The PieChartVisual structure describes a visual that is a member of the pie chart family.

The following charts can be described by using this structure:

For more information, see Using pie charts in the Amazon QuickSight User Guide.

For more information, see Using donut charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$PieChartVisual' => '

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

', ], ], 'PivotFieldSortOptions' => [ 'base' => '

The field sort options for a pivot table sort configuration.

', 'refs' => [ 'PivotFieldSortOptionsList$member' => NULL, ], ], 'PivotFieldSortOptionsList' => [ 'base' => NULL, 'refs' => [ 'PivotTableSortConfiguration$FieldSortOptions' => '

The field sort options for a pivot table sort configuration.

', ], ], 'PivotMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'PivotTableAggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

', ], ], 'PivotTableAggregatedFieldWells' => [ 'base' => '

The aggregated field well for the pivot table.

', 'refs' => [ 'PivotTableFieldWells$PivotTableAggregatedFieldWells' => '

The aggregated field well for the pivot table.

', ], ], 'PivotTableCellConditionalFormatting' => [ 'base' => '

The cell conditional formatting option for a pivot table.

', 'refs' => [ 'PivotTableConditionalFormattingOption$Cell' => '

The cell conditional formatting option for a pivot table.

', ], ], 'PivotTableConditionalFormatting' => [ 'base' => '

The conditional formatting for a PivotTableVisual.

', 'refs' => [ 'PivotTableVisual$ConditionalFormatting' => '

The conditional formatting for a PivotTableVisual.

', ], ], 'PivotTableConditionalFormattingOption' => [ 'base' => '

Conditional formatting options for a PivotTableVisual.

', 'refs' => [ 'PivotTableConditionalFormattingOptionList$member' => NULL, ], ], 'PivotTableConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options for a PivotTableVisual.

', ], ], 'PivotTableConditionalFormattingScope' => [ 'base' => '

The scope of the cell for conditional formatting.

', 'refs' => [ 'PivotTableCellConditionalFormatting$Scope' => '

The scope of the cell for conditional formatting.

', 'PivotTableConditionalFormattingScopeList$member' => NULL, ], ], 'PivotTableConditionalFormattingScopeList' => [ 'base' => NULL, 'refs' => [ 'PivotTableCellConditionalFormatting$Scopes' => '

A list of cell scopes for conditional formatting.

', ], ], 'PivotTableConditionalFormattingScopeRole' => [ 'base' => NULL, 'refs' => [ 'PivotTableConditionalFormattingScope$Role' => '

The role (field, field total, grand total) of the cell for conditional formatting.

', ], ], 'PivotTableConfiguration' => [ 'base' => '

The configuration for a PivotTableVisual.

', 'refs' => [ 'PivotTableVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'PivotTableDataPathOption' => [ 'base' => '

The data path options for the pivot table field options.

', 'refs' => [ 'PivotTableDataPathOptionList$member' => NULL, ], ], 'PivotTableDataPathOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$DataPathOptions' => '

The data path options for the pivot table field options.

', ], ], 'PivotTableDataPathType' => [ 'base' => NULL, 'refs' => [ 'DataPathType$PivotTableDataPathType' => '

The type of data path value utilized in a pivot table. Choose one of the following options:

', ], ], 'PivotTableDimensionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableAggregatedFieldWells$Rows' => '

The rows field well for a pivot table. Values are grouped by rows fields.

', 'PivotTableAggregatedFieldWells$Columns' => '

The columns field well for a pivot table. Values are grouped by columns fields.

', ], ], 'PivotTableFieldCollapseState' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldCollapseStateOption$State' => '

The state of the field target of a pivot table. Choose one of the following options:

', ], ], 'PivotTableFieldCollapseStateOption' => [ 'base' => '

The collapse state options for the pivot table field options.

', 'refs' => [ 'PivotTableFieldCollapseStateOptionList$member' => NULL, ], ], 'PivotTableFieldCollapseStateOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$CollapseStateOptions' => '

The collapse state options for the pivot table field options.

', ], ], 'PivotTableFieldCollapseStateTarget' => [ 'base' => '

The target of a pivot table field collapse state.

', 'refs' => [ 'PivotTableFieldCollapseStateOption$Target' => '

A tagged-union object that sets the collapse state.

', ], ], 'PivotTableFieldOption' => [ 'base' => '

The selected field options for the pivot table field options.

', 'refs' => [ 'PivotTableFieldOptionList$member' => NULL, ], ], 'PivotTableFieldOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTableFieldOptions$SelectedFieldOptions' => '

The selected field options for the pivot table field options.

', ], ], 'PivotTableFieldOptions' => [ 'base' => '

The field options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$FieldOptions' => '

The field options for a pivot table visual.

', ], ], 'PivotTableFieldSubtotalOptions' => [ 'base' => '

The optional configuration of subtotals cells.

', 'refs' => [ 'PivotTableFieldSubtotalOptionsList$member' => NULL, ], ], 'PivotTableFieldSubtotalOptionsList' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$FieldLevelOptions' => '

The optional configuration of subtotal cells.

', ], ], 'PivotTableFieldWells' => [ 'base' => '

The field wells for a pivot table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'PivotTableConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'PivotTableMetricPlacement' => [ 'base' => NULL, 'refs' => [ 'PivotTableOptions$MetricPlacement' => '

The metric placement (row, column) options.

', ], ], 'PivotTableOptions' => [ 'base' => '

The table options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$TableOptions' => '

The table options for a pivot table visual.

', ], ], 'PivotTablePaginatedReportOptions' => [ 'base' => '

The paginated report options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$PaginatedReportOptions' => '

The paginated report options for a pivot table visual.

', ], ], 'PivotTableRowsLabelOptions' => [ 'base' => '

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

', 'refs' => [ 'PivotTableOptions$RowsLabelOptions' => '

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

', ], ], 'PivotTableRowsLabelText' => [ 'base' => NULL, 'refs' => [ 'PivotTableRowsLabelOptions$CustomLabel' => '

The custom label string for the rows label.

', ], ], 'PivotTableRowsLayout' => [ 'base' => NULL, 'refs' => [ 'PivotTableOptions$RowsLayout' => '

The layout for the row dimension headers of a pivot table. Choose one of the following options.

', ], ], 'PivotTableSortBy' => [ 'base' => '

The sort by field for the field sort options.

', 'refs' => [ 'PivotFieldSortOptions$SortBy' => '

The sort by field for the field sort options.

', ], ], 'PivotTableSortConfiguration' => [ 'base' => '

The sort configuration for a PivotTableVisual.

', 'refs' => [ 'PivotTableConfiguration$SortConfiguration' => '

The sort configuration for a PivotTableVisual.

', ], ], 'PivotTableSubtotalLevel' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$FieldLevel' => '

The field level (all, custom, last) for the subtotal cells.

', ], ], 'PivotTableTotalOptions' => [ 'base' => '

The total options for a pivot table visual.

', 'refs' => [ 'PivotTableConfiguration$TotalOptions' => '

The total options for a pivot table visual.

', ], ], 'PivotTableVisual' => [ 'base' => '

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$PivotTableVisual' => '

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

', ], ], 'PivotTotalOptions' => [ 'base' => '

The optional configuration of totals cells in a PivotTableVisual.

', 'refs' => [ 'PivotTableTotalOptions$RowTotalOptions' => '

The row total options.

', 'PivotTableTotalOptions$ColumnTotalOptions' => '

The column total options.

', ], ], 'PixelLength' => [ 'base' => 'String based length that is composed of value and unit in px', 'refs' => [ 'AxisDisplayOptions$AxisOffset' => '

The offset value that determines the starting placement of the axis within a visual\'s bounds.

', 'FreeFormLayoutElement$XAxisLocation' => '

The x-axis coordinate of the element.

', 'FreeFormLayoutElement$Width' => '

The width of an element within a free-form layout.

', 'FreeFormLayoutElement$Height' => '

The height of an element within a free-form layout.

', 'FreeFormLayoutScreenCanvasSizeOptions$OptimizedViewPortWidth' => '

The width that the view port will be optimized for when the layout renders.

', 'GridLayoutScreenCanvasSizeOptions$OptimizedViewPortWidth' => '

The width that the view port will be optimized for when the layout renders.

', 'LegendOptions$Width' => '

The width of the legend. If this value is omitted, a default width is used when rendering.

', 'LegendOptions$Height' => '

The height of the legend. If this value is omitted, a default height is used when rendering.

', 'LineChartLineStyleSettings$LineWidth' => '

Width that determines the line thickness.

', 'LineChartMarkerStyleSettings$MarkerSize' => '

Size of marker in the series.

', 'PanelConfiguration$BorderThickness' => '

Sets the line thickness of panel borders.

', 'PanelConfiguration$GutterSpacing' => '

Sets the total amount of negative space to display between sibling panels.

', 'PivotTableDataPathOption$Width' => '

The width of the data path option.

', 'PivotTableOptions$DefaultCellWidth' => '

The default cell width of the pivot table.

', 'SectionStyle$Height' => '

The height of a section.

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

', 'TableFieldOption$Width' => '

The width for a table field.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'AuroraParameters$Port' => '

Port.

', 'AuroraPostgreSqlParameters$Port' => '

The port that Amazon Aurora PostgreSQL is listening on.

', 'DatabricksParameters$Port' => '

The port for the Databricks data source.

', 'ExasolParameters$Port' => '

The port for the Exasol data source.

', 'MariaDbParameters$Port' => '

Port.

', 'MySqlParameters$Port' => '

Port.

', 'OracleParameters$Port' => '

The port.

', 'PostgreSqlParameters$Port' => '

Port.

', 'PrestoParameters$Port' => '

Port.

', 'SparkParameters$Port' => '

Port.

', 'SqlServerParameters$Port' => '

Port.

', 'StarburstParameters$Port' => '

The port for the Starburst data source.

', 'TeradataParameters$Port' => '

Port.

', 'TrinoParameters$Port' => '

The port for the Trino data source.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'TwitterParameters$MaxRows' => '

Maximum number of rows to query Twitter.

', 'UploadSettings$StartFromRow' => '

A row number to start reading data from.

', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'LookbackWindow$Size' => '

The lookback window column size.

', ], ], 'PostgreSqlParameters' => [ 'base' => '

The parameters for PostgreSQL.

', 'refs' => [ 'DataSourceParameters$PostgreSqlParameters' => '

The parameters for PostgreSQL.

', ], ], 'PreconditionNotMetException' => [ 'base' => '

One or more preconditions aren\'t met.

', 'refs' => [], ], 'PredefinedHierarchy' => [ 'base' => '

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

', 'refs' => [ 'ColumnHierarchy$PredefinedHierarchy' => '

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

', ], ], 'PredefinedHierarchyColumnList' => [ 'base' => NULL, 'refs' => [ 'PredefinedHierarchy$Columns' => '

The list of columns that define the predefined hierarchy.

', ], ], 'PredictionInterval' => [ 'base' => NULL, 'refs' => [ 'ForecastComputation$PredictionInterval' => '

The prediction interval setup of a forecast computation.

', 'TimeBasedForecastProperties$PredictionInterval' => '

The prediction interval setup of a forecast computation.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the currency format.

', 'NumberDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the number format.

', 'PercentageDisplayFormatConfiguration$Prefix' => '

Determines the prefix value of the percentage format.

', ], ], 'PrestoParameters' => [ 'base' => '

The parameters for Presto.

', 'refs' => [ 'DataSourceParameters$PrestoParameters' => '

The parameters for Presto.

', ], ], 'PrimaryValueDisplayType' => [ 'base' => NULL, 'refs' => [ 'GaugeChartOptions$PrimaryValueDisplayType' => '

The options that determine the primary value display type.

', 'KPIOptions$PrimaryValueDisplayType' => '

The options that determine the primary value display type.

', ], ], 'Principal' => [ 'base' => NULL, 'refs' => [ 'AssetBundlePrincipalList$member' => NULL, 'ResourcePermission$Principal' => '

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

', ], ], 'PrincipalList' => [ 'base' => NULL, 'refs' => [ 'ColumnLevelPermissionRule$Principals' => '

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

', ], ], 'ProgressBarOptions' => [ 'base' => '

The options that determine the presentation of the progress bar of a KPI visual.

', 'refs' => [ 'KPIOptions$ProgressBar' => '

The options that determine the presentation of the progress bar of a KPI visual.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'BigQueryParameters$ProjectId' => '

The Google Cloud Platform project ID where your datasource was created.

', ], ], 'ProjectOperation' => [ 'base' => '

A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.

', 'refs' => [ 'TransformOperation$ProjectOperation' => '

An operation that projects columns. Operations that come after a projection can only refer to projected columns.

', ], ], 'ProjectedColumnList' => [ 'base' => NULL, 'refs' => [ 'ProjectOperation$ProjectedColumns' => '

Projected columns.

', ], ], 'PropertyRole' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinition$PropertyRole' => '

The property role. Valid values for this structure are PRIMARY and ID.

', ], ], 'PropertyUsage' => [ 'base' => NULL, 'refs' => [ 'NamedEntityDefinition$PropertyUsage' => '

The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

', ], ], 'PurchaseMode' => [ 'base' => NULL, 'refs' => [ 'UpdateSPICECapacityConfigurationRequest$PurchaseMode' => '

Determines how SPICE capacity can be purchased. The following options are available.

', ], ], 'PutDataSetRefreshPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDataSetRefreshPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Query' => [ 'base' => NULL, 'refs' => [ 'TwitterParameters$Query' => '

Twitter query string.

', ], ], 'QueryExecutionMode' => [ 'base' => NULL, 'refs' => [ 'QueryExecutionOptions$QueryExecutionMode' => '

A structure that describes the query execution mode.

', ], ], 'QueryExecutionOptions' => [ 'base' => '

A structure that describes the query execution options.

', 'refs' => [ 'AnalysisDefinition$QueryExecutionOptions' => NULL, 'TemplateVersionDefinition$QueryExecutionOptions' => NULL, ], ], 'QueueInfo' => [ 'base' => '

Information about a queued dataset SPICE ingestion.

', 'refs' => [ 'Ingestion$QueueInfo' => NULL, ], ], 'QuickSightUserNotFoundException' => [ 'base' => '

The user with the provided name isn\'t found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.

', 'refs' => [], ], 'RadarChartAggregatedFieldWells' => [ 'base' => '

The aggregated field well configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartFieldWells$RadarChartAggregatedFieldWells' => '

The aggregated field wells of a radar chart visual.

', ], ], 'RadarChartAreaStyleSettings' => [ 'base' => '

The configured style settings of a radar chart.

', 'refs' => [ 'RadarChartSeriesSettings$AreaStyleSettings' => '

The area style settings of a radar chart.

', ], ], 'RadarChartAxesRangeScale' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$AxesRangeScale' => '

The axis behavior options of a radar chart.

', ], ], 'RadarChartCategoryFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Category' => '

The aggregated field well categories of a radar chart.

', ], ], 'RadarChartColorFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Color' => '

The color that are assigned to the aggregated field wells of a radar chart.

', ], ], 'RadarChartConfiguration' => [ 'base' => '

The configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'RadarChartFieldWells' => [ 'base' => '

The field wells of a radar chart visual.

', 'refs' => [ 'RadarChartConfiguration$FieldWells' => '

The field well configuration of a RadarChartVisual.

', ], ], 'RadarChartSeriesSettings' => [ 'base' => '

The series settings of a radar chart.

', 'refs' => [ 'RadarChartConfiguration$BaseSeriesSettings' => '

The base sreies settings of a radar chart.

', ], ], 'RadarChartShape' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$Shape' => '

The shape of the radar chart.

', ], ], 'RadarChartSortConfiguration' => [ 'base' => '

The sort configuration of a RadarChartVisual.

', 'refs' => [ 'RadarChartConfiguration$SortConfiguration' => '

The sort configuration of a RadarChartVisual.

', ], ], 'RadarChartStartAngle' => [ 'base' => NULL, 'refs' => [ 'RadarChartConfiguration$StartAngle' => '

The start angle of a radar chart\'s axis.

', ], ], 'RadarChartValuesFieldList' => [ 'base' => NULL, 'refs' => [ 'RadarChartAggregatedFieldWells$Values' => '

The values that are assigned to the aggregated field wells of a radar chart.

', ], ], 'RadarChartVisual' => [ 'base' => '

A radar chart visual.

', 'refs' => [ 'Visual$RadarChartVisual' => '

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide.

', ], ], 'RangeConstant' => [ 'base' => '

A structure that represents a range constant.

', 'refs' => [ 'TopicRangeFilterConstant$RangeConstant' => '

The value of the constant that is used to specify the endpoints of a range filter.

', ], ], 'RangeEndsLabelType' => [ 'base' => '

The range ends label type of a data path label.

', 'refs' => [ 'DataLabelType$RangeEndsLabelType' => '

Determines the label configuration for range end value in a visual.

', ], ], 'RdsParameters' => [ 'base' => '

The parameters for Amazon RDS.

', 'refs' => [ 'DataSourceParameters$RdsParameters' => '

The parameters for Amazon RDS.

', ], ], 'RecoveryWindowInDays' => [ 'base' => NULL, 'refs' => [ 'DeleteAnalysisRequest$RecoveryWindowInDays' => '

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.

', ], ], 'RedshiftIAMParameters' => [ 'base' => '

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 .

', 'refs' => [ 'RedshiftParameters$IAMParameters' => '

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

', ], ], 'RedshiftParameters' => [ 'base' => '

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.

', 'refs' => [ 'DataSourceParameters$RedshiftParameters' => '

The parameters for Amazon Redshift.

', ], ], 'ReferenceLine' => [ 'base' => '

The reference line visual display options.

', 'refs' => [ 'ReferenceLineList$member' => NULL, ], ], 'ReferenceLineCustomLabelConfiguration' => [ 'base' => '

The configuration for a custom label on a ReferenceLine.

', 'refs' => [ 'ReferenceLineLabelConfiguration$CustomLabelConfiguration' => '

The custom label configuration of the label in a reference line.

', ], ], 'ReferenceLineDataConfiguration' => [ 'base' => '

The data configuration of the reference line.

', 'refs' => [ 'ReferenceLine$DataConfiguration' => '

The data configuration of the reference line.

', ], ], 'ReferenceLineDynamicDataConfiguration' => [ 'base' => '

The dynamic configuration of the reference line data configuration.

', 'refs' => [ 'ReferenceLineDataConfiguration$DynamicConfiguration' => '

The dynamic configuration of the reference line data configuration.

', ], ], 'ReferenceLineLabelConfiguration' => [ 'base' => '

The label configuration of a reference line.

', 'refs' => [ 'ReferenceLine$LabelConfiguration' => '

The label configuration of the reference line.

', ], ], 'ReferenceLineLabelHorizontalPosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineLabelConfiguration$HorizontalPosition' => '

The horizontal position configuration of the label in a reference line. Choose one of the following options:

', ], ], 'ReferenceLineLabelVerticalPosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineLabelConfiguration$VerticalPosition' => '

The vertical position configuration of the label in a reference line. Choose one of the following options:

', ], ], 'ReferenceLineList' => [ 'base' => NULL, 'refs' => [ 'BarChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'BoxPlotChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'ComboChartConfiguration$ReferenceLines' => '

The reference line setup of the visual.

', 'LineChartConfiguration$ReferenceLines' => '

The reference lines configuration of a line chart.

', ], ], 'ReferenceLinePatternType' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineStyleConfiguration$Pattern' => '

The pattern type of the line style. Choose one of the following options:

', ], ], 'ReferenceLineSeriesType' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineDataConfiguration$SeriesType' => '

The series type of the reference line data configuration. Choose one of the following options:

', ], ], 'ReferenceLineStaticDataConfiguration' => [ 'base' => '

The static data configuration of the reference line data configuration.

', 'refs' => [ 'ReferenceLineDataConfiguration$StaticConfiguration' => '

The static data configuration of the reference line data configuration.

', ], ], 'ReferenceLineStyleConfiguration' => [ 'base' => '

The style configuration of the reference line.

', 'refs' => [ 'ReferenceLine$StyleConfiguration' => '

The style configuration of the reference line.

', ], ], 'ReferenceLineValueLabelConfiguration' => [ 'base' => '

The value label configuration of the label in a reference line.

', 'refs' => [ 'ReferenceLineLabelConfiguration$ValueLabelConfiguration' => '

The value label configuration of the label in a reference line.

', ], ], 'ReferenceLineValueLabelRelativePosition' => [ 'base' => NULL, 'refs' => [ 'ReferenceLineValueLabelConfiguration$RelativePosition' => '

The relative position of the value label. Choose one of the following options:

', ], ], 'RefreshConfiguration' => [ 'base' => '

The refresh configuration of a dataset.

', 'refs' => [ 'DataSetRefreshProperties$RefreshConfiguration' => '

The refresh configuration for a dataset.

', ], ], 'RefreshFrequency' => [ 'base' => '

Specifies the interval between each scheduled refresh of a dataset.

', 'refs' => [ 'RefreshSchedule$ScheduleFrequency' => '

The frequency for the refresh schedule.

', ], ], 'RefreshInterval' => [ 'base' => NULL, 'refs' => [ 'RefreshFrequency$Interval' => '

The interval between scheduled refreshes. Valid values are as follows:

', ], ], 'RefreshSchedule' => [ 'base' => '

The refresh schedule of a dataset.

', 'refs' => [ 'CreateRefreshScheduleRequest$Schedule' => '

The refresh schedule.

', 'DescribeRefreshScheduleResponse$RefreshSchedule' => '

The refresh schedule.

', 'RefreshSchedules$member' => '

A list of RefreshSchedule objects.

', 'UpdateRefreshScheduleRequest$Schedule' => '

The refresh schedule.

', ], ], 'RefreshSchedules' => [ 'base' => NULL, 'refs' => [ 'ListRefreshSchedulesResponse$RefreshSchedules' => '

The list of refresh schedules for the dataset.

', ], ], 'RegisterUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisteredCustomerManagedKey' => [ 'base' => '

A customer managed key structure that contains the information listed below:

', 'refs' => [ 'KeyRegistration$member' => NULL, ], ], 'RegisteredUserConsoleFeatureConfigurations' => [ 'base' => '

The feature configurations of an embedded Amazon QuickSight console.

', 'refs' => [ 'RegisteredUserQuickSightConsoleEmbeddingConfiguration$FeatureConfigurations' => '

The embedding configuration of an embedded Amazon QuickSight console.

', ], ], 'RegisteredUserDashboardEmbeddingConfiguration' => [ 'base' => '

Information about the dashboard you want to embed.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$Dashboard' => '

The configuration details for providing a dashboard embedding experience.

', ], ], 'RegisteredUserDashboardFeatureConfigurations' => [ 'base' => '

The feature configuration for an embedded dashboard.

', 'refs' => [ 'RegisteredUserDashboardEmbeddingConfiguration$FeatureConfigurations' => '

The feature configurations of an embbedded Amazon QuickSight dashboard.

', ], ], 'RegisteredUserDashboardVisualEmbeddingConfiguration' => [ 'base' => '

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$DashboardVisual' => '

The type of embedding experience. In this case, Amazon QuickSight visuals.

', ], ], 'RegisteredUserEmbeddingExperienceConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'GenerateEmbedUrlForRegisteredUserRequest$ExperienceConfiguration' => '

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.

', ], ], 'RegisteredUserGenerativeQnAEmbeddingConfiguration' => [ 'base' => '

An object that provides information about the configuration of a Generative Q&A experience.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$GenerativeQnA' => '

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.

', ], ], 'RegisteredUserQSearchBarEmbeddingConfiguration' => [ 'base' => '

Information about the Q search bar embedding experience.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$QSearchBar' => '

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.

', ], ], 'RegisteredUserQuickSightConsoleEmbeddingConfiguration' => [ 'base' => '

Information about the Amazon QuickSight console that you want to embed.

', 'refs' => [ 'RegisteredUserEmbeddingExperienceConfiguration$QuickSightConsole' => '

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.

', ], ], 'RelationalTable' => [ 'base' => '

A physical table type for relational data sources.

', 'refs' => [ 'PhysicalTable$RelationalTable' => '

A physical table type for relational data sources.

', ], ], 'RelationalTableCatalog' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Catalog' => '

The catalog associated with a table.

', ], ], 'RelationalTableName' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Name' => '

The name of the relational table.

', ], ], 'RelationalTableSchema' => [ 'base' => NULL, 'refs' => [ 'RelationalTable$Schema' => '

The schema name. This name applies to certain relational database engines.

', ], ], 'RelativeDateTimeControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultRelativeDateTimeControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterRelativeDateTimeControl$DisplayOptions' => '

The display options of a control.

', ], ], 'RelativeDateType' => [ 'base' => NULL, 'refs' => [ 'RelativeDatesFilter$RelativeDateType' => '

The range date type of the filter. Choose one of the options below:

', ], ], 'RelativeDatesFilter' => [ 'base' => '

A RelativeDatesFilter filters relative dates values.

', 'refs' => [ 'Filter$RelativeDatesFilter' => '

A RelativeDatesFilter filters date values that are relative to a given date.

', ], ], 'RelativeFontSize' => [ 'base' => NULL, 'refs' => [ 'FontSize$Relative' => '

The lexical name for the text size, proportional to its surrounding context.

', ], ], 'RenameColumnOperation' => [ 'base' => '

A transform operation that renames a column.

', 'refs' => [ 'TransformOperation$RenameColumnOperation' => '

An operation that renames a column.

', ], ], 'ResizeOption' => [ 'base' => NULL, 'refs' => [ 'GridLayoutScreenCanvasSizeOptions$ResizeOption' => '

This value determines the layout behavior when the viewport is resized.

', ], ], 'ResourceExistsException' => [ 'base' => '

The resource specified already exists.

', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParameters$AnalysisId' => '

The ID of the analysis that you ant to apply overrides to.

', 'AssetBundleImportJobDashboardOverrideParameters$DashboardId' => '

The ID of the dashboard that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverrideParameters$DataSetId' => '

The ID of the dataset to apply overrides to.

', 'AssetBundleImportJobDataSourceOverrideParameters$DataSourceId' => '

The ID of the data source to apply overrides to.

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$DataSetId' => '

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

', 'AssetBundleImportJobThemeOverrideParameters$ThemeId' => '

The ID of the theme to apply overrides to.

', 'CreateDataSetRequest$DataSetId' => '

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSetResponse$IngestionId' => '

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'CreateDataSourceRequest$DataSourceId' => '

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DataSet$DataSetId' => '

The ID of the dataset.

', 'DataSetSummary$DataSetId' => '

The ID of the dataset.

', 'DataSource$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DataSourceSummary$DataSourceId' => '

The unique ID of the data source.

', 'DeleteDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'DeleteDataSetRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeDataSetPermissionsRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSetPermissionsResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeDataSetRequest$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourcePermissionsRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourcePermissionsResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', 'DescribeTopicRefreshRequest$RefreshId' => '

The ID of the refresh, which is performed when the topic is created or updated.

', 'ListRefreshSchedulesRequest$DataSetId' => '

The ID of the dataset.

', 'PutDataSetRefreshPropertiesRequest$DataSetId' => '

The ID of the dataset.

', 'TopicRefreshDetails$RefreshId' => '

The ID of the refresh, which occurs as a result of topic creation or topic update.

', 'UpdateDataSetPermissionsRequest$DataSetId' => '

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetPermissionsResponse$DataSetId' => '

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetRequest$DataSetId' => '

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetResponse$DataSetId' => '

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSetResponse$IngestionId' => '

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

', 'UpdateDataSourcePermissionsRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourcePermissionsResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourceRequest$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateDataSourceResponse$DataSourceId' => '

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateRefreshScheduleRequest$DataSetId' => '

The ID of the dataset.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideParameters$Name' => '

A new name for the analysis.

', 'AssetBundleImportJobDashboardOverrideParameters$Name' => '

A new name for the dashboard.

', 'AssetBundleImportJobDataSetOverrideParameters$Name' => '

A new name for the dataset.

', 'AssetBundleImportJobDataSourceOverrideParameters$Name' => '

A new name for the data source.

', 'AssetBundleImportJobThemeOverrideParameters$Name' => '

A new name for the theme.

', 'AssetBundleImportJobVPCConnectionOverrideParameters$Name' => '

A new name for the VPC connection.

', 'CreateDataSetRequest$Name' => '

The display name for the dataset.

', 'CreateDataSourceRequest$Name' => '

A display name for the data source.

', 'CreateVPCConnectionRequest$Name' => '

The display name for the VPC connection.

', 'DataSet$Name' => '

A display name for the dataset.

', 'DataSetSummary$Name' => '

A display name for the dataset.

', 'DataSource$Name' => '

A display name for the data source.

', 'DataSourceSummary$Name' => '

The name of the data source.

', 'TopicDetails$Name' => '

The name of the topic.

', 'TopicSummary$Name' => '

The name of the topic.

', 'UpdateDataSetRequest$Name' => '

The display name for the dataset.

', 'UpdateDataSourceRequest$Name' => '

A display name for the data source.

', 'UpdateVPCConnectionRequest$Name' => '

The display name for the VPC connection.

', 'VPCConnection$Name' => '

The display name for the VPC connection.

', 'VPCConnectionSummary$Name' => '

The display name for the VPC connection.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

One or more resources can\'t be found.

', 'refs' => [], ], 'ResourcePermission' => [ 'base' => '

Permission for the resource.

', 'refs' => [ 'ResourcePermissionList$member' => NULL, 'UpdateLinkPermissionList$member' => NULL, 'UpdateResourcePermissionList$member' => NULL, ], ], 'ResourcePermissionList' => [ 'base' => NULL, 'refs' => [ 'CreateAnalysisRequest$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

', 'CreateDashboardRequest$Permissions' => '

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

', 'CreateDataSetRequest$Permissions' => '

A list of resource permissions on the dataset.

', 'CreateDataSourceRequest$Permissions' => '

A list of resource permissions on the data source.

', 'CreateFolderRequest$Permissions' => '

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

', 'CreateTemplateRequest$Permissions' => '

A list of resource permissions to be set on the template.

', 'CreateThemeRequest$Permissions' => '

A valid grouping of resource permissions to apply to the new theme.

', 'DescribeAnalysisPermissionsResponse$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis.

', 'DescribeDashboardPermissionsResponse$Permissions' => '

A structure that contains the permissions for the dashboard.

', 'DescribeDataSetPermissionsResponse$Permissions' => '

A list of resource permissions on the dataset.

', 'DescribeDataSourcePermissionsResponse$Permissions' => '

A list of resource permissions on the data source.

', 'DescribeFolderPermissionsResponse$Permissions' => '

Information about the permissions on the folder.

', 'DescribeFolderResolvedPermissionsResponse$Permissions' => '

Information about the permissions for the folder.

', 'DescribeTemplatePermissionsResponse$Permissions' => '

A list of resource permissions to be set on the template.

', 'DescribeThemePermissionsResponse$Permissions' => '

A list of resource permissions set on the theme.

', 'DescribeTopicPermissionsResponse$Permissions' => '

A list of resource permissions that are configured to the topic.

', 'LinkSharingConfiguration$Permissions' => '

A structure that contains the permissions of a shareable link.

', 'UpdateAnalysisPermissionsResponse$Permissions' => '

A structure that describes the principals and the resource-level permissions on an analysis.

', 'UpdateDashboardPermissionsResponse$Permissions' => '

Information about the permissions on the dashboard.

', 'UpdateDataSetPermissionsRequest$GrantPermissions' => '

The resource permissions that you want to grant to the dataset.

', 'UpdateDataSetPermissionsRequest$RevokePermissions' => '

The resource permissions that you want to revoke from the dataset.

', 'UpdateDataSourcePermissionsRequest$GrantPermissions' => '

A list of resource permissions that you want to grant on the data source.

', 'UpdateDataSourcePermissionsRequest$RevokePermissions' => '

A list of resource permissions that you want to revoke on the data source.

', 'UpdateFolderPermissionsRequest$GrantPermissions' => '

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

', 'UpdateFolderPermissionsRequest$RevokePermissions' => '

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

', 'UpdateFolderPermissionsResponse$Permissions' => '

Information about the permissions for the folder.

', 'UpdateTemplatePermissionsResponse$Permissions' => '

A list of resource permissions to be set on the template.

', 'UpdateThemePermissionsResponse$Permissions' => '

The resulting list of resource permissions for the theme.

', 'UpdateTopicPermissionsResponse$Permissions' => '

A list of resource permissions on the topic.

', ], ], 'ResourceStatus' => [ 'base' => NULL, 'refs' => [ 'Analysis$Status' => '

Status associated with the analysis.

', 'AnalysisSummary$Status' => '

The last known status for the analysis.

', 'CreateAnalysisResponse$CreationStatus' => '

The status of the creation of the analysis.

', 'CreateDashboardResponse$CreationStatus' => '

The status of the dashboard creation request.

', 'CreateDataSourceResponse$CreationStatus' => '

The status of creating the data source.

', 'CreateTemplateResponse$CreationStatus' => '

The template creation status.

', 'CreateThemeResponse$CreationStatus' => '

The theme creation status.

', 'DashboardVersion$Status' => '

The HTTP status of the request.

', 'DashboardVersionSummary$Status' => '

The HTTP status of the request.

', 'DataSource$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisDefinitionResponse$ResourceStatus' => '

Status associated with the analysis.

', 'DescribeDashboardDefinitionResponse$ResourceStatus' => '

Status associated with the dashboard version.

', 'DescribeTemplateDefinitionResponse$ResourceStatus' => '

Status associated with the template.

', 'TemplateVersion$Status' => '

The status that is associated with the template.

', 'TemplateVersionSummary$Status' => '

The status of the template version.

', 'ThemeVersion$Status' => '

The status of the theme version.

', 'ThemeVersionSummary$Status' => '

The status of the theme version.

', 'UpdateAnalysisResponse$UpdateStatus' => '

The update status of the last update that was made to the analysis.

', 'UpdateDashboardResponse$CreationStatus' => '

The creation status of the request.

', 'UpdateDataSourceResponse$UpdateStatus' => '

The update status of the data source\'s last update.

', 'UpdateTemplateResponse$CreationStatus' => '

The creation status of the template.

', 'UpdateThemeResponse$CreationStatus' => '

The creation status of the theme.

', ], ], 'ResourceUnavailableException' => [ 'base' => '

This resource is currently unavailable.

', 'refs' => [], ], 'RestoreAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'RestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserGenerativeQnAEmbeddingConfiguration$InitialTopicId' => '

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.

', 'AnonymousUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

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.

', 'CreateFolderMembershipRequest$FolderId' => '

The ID of the folder.

', 'CreateFolderMembershipRequest$MemberId' => '

The ID of the asset that you want to add to the folder.

', 'CreateFolderRequest$FolderId' => '

The ID of the folder.

', 'CreateFolderResponse$FolderId' => '

The folder ID for the newly created folder.

', 'DeleteFolderMembershipRequest$FolderId' => '

The Folder ID.

', 'DeleteFolderMembershipRequest$MemberId' => '

The ID of the asset that you want to delete.

', 'DeleteFolderRequest$FolderId' => '

The ID of the folder.

', 'DeleteFolderResponse$FolderId' => '

The ID of the folder.

', 'DescribeFolderPermissionsRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderPermissionsResponse$FolderId' => '

The ID of the folder.

', 'DescribeFolderRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderResolvedPermissionsRequest$FolderId' => '

The ID of the folder.

', 'DescribeFolderResolvedPermissionsResponse$FolderId' => '

The ID of the folder.

', 'Folder$FolderId' => '

The ID of the folder.

', 'FolderMember$MemberId' => '

The ID of an asset in the folder.

', 'FolderSummary$FolderId' => '

The ID of the folder.

', 'ListFolderMembersRequest$FolderId' => '

The ID of the folder.

', 'MemberIdArnPair$MemberId' => '

The ID of the member.

', 'RegisteredUserGenerativeQnAEmbeddingConfiguration$InitialTopicId' => '

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.

', 'RegisteredUserQSearchBarEmbeddingConfiguration$InitialTopicId' => '

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.

', 'UpdateFolderPermissionsRequest$FolderId' => '

The ID of the folder.

', 'UpdateFolderPermissionsResponse$FolderId' => '

The ID of the folder.

', 'UpdateFolderRequest$FolderId' => '

The ID of the folder.

', 'UpdateFolderResponse$FolderId' => '

The ID of the folder.

', ], ], 'ReviewedAnswerErrorCode' => [ 'base' => NULL, 'refs' => [ 'InvalidTopicReviewedAnswer$Error' => '

The error that is returned for the InvalidTopicReviewedAnswer.

', ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'CreateRoleMembershipRequest$Role' => '

The role that you want to add a group to.

', 'DeleteRoleCustomPermissionRequest$Role' => '

The role that you want to remove permissions from.

', 'DeleteRoleMembershipRequest$Role' => '

The role that you want to remove permissions from.

', 'DescribeRoleCustomPermissionRequest$Role' => '

The name of the role whose permissions you want described.

', 'ListRoleMembershipsRequest$Role' => '

The name of the role.

', 'UpdateRoleCustomPermissionRequest$Role' => '

The name of role tht you want to update.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$RoleArn' => '

An optional override of the role ARN to be used by the VPC connection.

', 'AthenaParameters$RoleArn' => '

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

', 'CreateVPCConnectionRequest$RoleArn' => '

The IAM role to associate with the VPC connection.

', 'RedshiftIAMParameters$RoleArn' => '

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.

', 'S3Parameters$RoleArn' => '

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

', 'UpdateVPCConnectionRequest$RoleArn' => '

An IAM role associated with the VPC connection.

', ], ], 'RoleName' => [ 'base' => NULL, 'refs' => [ 'DescribeRoleCustomPermissionResponse$CustomPermissionsName' => '

The name of the custom permission that is described.

', 'RegisterUserRequest$CustomPermissionsName' => '

(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:

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.

', 'UpdateRoleCustomPermissionRequest$CustomPermissionsName' => '

The name of the custom permission that you want to update the role with.

', 'UpdateUserRequest$CustomPermissionsName' => '

(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:

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.

', 'User$CustomPermissionsName' => '

The custom permissions profile associated with this user.

', ], ], 'RoleSessionName' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$SessionName' => '

You need to use this parameter only when you register one or more users using an assumed IAM role. You don\'t need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.

', ], ], 'RollingDateConfiguration' => [ 'base' => '

The rolling date configuration of a date time filter.

', 'refs' => [ 'DateTimeDefaultValues$RollingDate' => '

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

', 'TimeEqualityFilter$RollingDate' => '

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName.

', 'TimeRangeFilterValue$RollingDate' => '

The rolling date input value.

', ], ], 'RowAlternateColorList' => [ 'base' => NULL, 'refs' => [ 'RowAlternateColorOptions$RowAlternateColors' => '

Determines the list of row alternate colors.

', ], ], 'RowAlternateColorOptions' => [ 'base' => '

Determines the row alternate color options.

', 'refs' => [ 'PivotTableOptions$RowAlternateColorOptions' => '

The row alternate color options (widget status, row alternate colors).

', 'TableOptions$RowAlternateColorOptions' => '

The row alternate color options (widget status, row alternate colors) for a table.

', ], ], 'RowInfo' => [ 'base' => '

Information about rows for a data set SPICE ingestion.

', 'refs' => [ 'Ingestion$RowInfo' => NULL, ], ], 'RowLevelPermissionDataSet' => [ 'base' => '

Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

', 'refs' => [ 'CreateDataSetRequest$RowLevelPermissionDataSet' => '

The row-level security configuration for the data that you want to create.

', 'DataSet$RowLevelPermissionDataSet' => '

The row-level security configuration for the dataset.

', 'DataSetSummary$RowLevelPermissionDataSet' => '

The row-level security configuration for the dataset.

', 'UpdateDataSetRequest$RowLevelPermissionDataSet' => '

The row-level security configuration for the data you want to create.

', ], ], 'RowLevelPermissionFormatVersion' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$FormatVersion' => '

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

', ], ], 'RowLevelPermissionPolicy' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$PermissionPolicy' => '

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

', ], ], 'RowLevelPermissionTagConfiguration' => [ 'base' => '

The configuration of tags on a dataset to set row-level security.

', 'refs' => [ 'CreateDataSetRequest$RowLevelPermissionTagConfiguration' => '

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

', 'DataSet$RowLevelPermissionTagConfiguration' => '

The element you can use to define tags for row-level security.

', 'UpdateDataSetRequest$RowLevelPermissionTagConfiguration' => '

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

', ], ], 'RowLevelPermissionTagDelimiter' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$TagMultiValueDelimiter' => '

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

', ], ], 'RowLevelPermissionTagRule' => [ 'base' => '

A set of rules associated with a tag.

', 'refs' => [ 'RowLevelPermissionTagRuleList$member' => NULL, ], ], 'RowLevelPermissionTagRuleConfiguration' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRuleConfigurationList$member' => NULL, ], ], 'RowLevelPermissionTagRuleConfigurationList' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagConfiguration$TagRuleConfigurations' => '

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

', ], ], 'RowLevelPermissionTagRuleList' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagConfiguration$TagRules' => '

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

', ], ], 'RowSortList' => [ 'base' => NULL, 'refs' => [ 'TableSortConfiguration$RowSort' => '

The field sort options for rows in the table.

', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'ManifestFileLocation$Bucket' => '

Amazon S3 bucket.

', ], ], 'S3BucketConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'SnapshotS3DestinationConfiguration$BucketConfiguration' => '

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'ManifestFileLocation$Key' => '

Amazon S3 key that identifies an object.

', ], ], 'S3Parameters' => [ 'base' => '

The parameters for S3.

', 'refs' => [ 'DataSourceParameters$S3Parameters' => '

The parameters for S3.

', ], ], 'S3Source' => [ 'base' => '

A physical table type for an S3 data source.

', 'refs' => [ 'PhysicalTable$S3Source' => '

A physical table type for as S3 data source.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSource$S3Uri' => '

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can\'t exceed 20 MB.

', 'AssetBundleImportSourceDescription$S3Uri' => '

The Amazon S3 URI that you provided at the start of the import job.

', ], ], 'SameSheetTargetVisualConfiguration' => [ 'base' => '

The configuration of the same-sheet target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterOperationTargetVisualsConfiguration$SameSheetTargetVisualConfiguration' => '

The configuration of the same-sheet target visuals that you want to be filtered.

', ], ], 'SankeyDiagramAggregatedFieldWells' => [ 'base' => '

The field well configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramFieldWells$SankeyDiagramAggregatedFieldWells' => '

The field well configuration of a sankey diagram.

', ], ], 'SankeyDiagramChartConfiguration' => [ 'base' => '

The configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramVisual$ChartConfiguration' => '

The configuration of a sankey diagram.

', ], ], 'SankeyDiagramFieldWells' => [ 'base' => '

The field well configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramChartConfiguration$FieldWells' => '

The field well configuration of a sankey diagram.

', ], ], 'SankeyDiagramSortConfiguration' => [ 'base' => '

The sort configuration of a sankey diagram.

', 'refs' => [ 'SankeyDiagramChartConfiguration$SortConfiguration' => '

The sort configuration of a sankey diagram.

', ], ], 'SankeyDiagramVisual' => [ 'base' => '

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$SankeyDiagramVisual' => '

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

', ], ], 'ScatterPlotCategoricallyAggregatedFieldWells' => [ 'base' => '

The aggregated field well of a scatter plot.

', 'refs' => [ 'ScatterPlotFieldWells$ScatterPlotCategoricallyAggregatedFieldWells' => '

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

', ], ], 'ScatterPlotConfiguration' => [ 'base' => '

The configuration of a scatter plot.

', 'refs' => [ 'ScatterPlotVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'ScatterPlotFieldWells' => [ 'base' => '

The field well configuration of a scatter plot.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'ScatterPlotConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'ScatterPlotSortConfiguration' => [ 'base' => '

The sort configuration of a scatter plot.

', 'refs' => [ 'ScatterPlotConfiguration$SortConfiguration' => '

The sort configuration of a scatter plot.

', ], ], 'ScatterPlotUnaggregatedFieldWells' => [ 'base' => '

The unaggregated field wells of a scatter plot.

', 'refs' => [ 'ScatterPlotFieldWells$ScatterPlotUnaggregatedFieldWells' => '

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated.

', ], ], 'ScatterPlotVisual' => [ 'base' => '

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$ScatterPlotVisual' => '

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

', ], ], 'ScheduleRefreshOnEntity' => [ 'base' => '

The refresh on entity for weekly or monthly schedules.

', 'refs' => [ 'RefreshFrequency$RefreshOnDay' => '

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

', ], ], 'ScrollBarOptions' => [ 'base' => '

The visual display options for a data zoom scroll bar.

', 'refs' => [ 'AxisDisplayOptions$ScrollbarOptions' => '

The scroll bar options for an axis.

', ], ], 'SearchAnalysesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAnalysesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDashboardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDashboardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchDataSourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchFoldersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFoldersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Seasonality' => [ 'base' => NULL, 'refs' => [ 'TimeBasedForecastProperties$Seasonality' => '

The seasonality setup of a forecast computation. Choose one of the following options:

', ], ], 'SecondaryValueOptions' => [ 'base' => '

The options that determine the presentation of the secondary value of a KPI visual.

', 'refs' => [ 'KPIOptions$SecondaryValue' => '

The options that determine the presentation of the secondary value of a KPI visual.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobDataSourceCredentials$SecretArn' => '

The ARN of the Secrets Manager secret that\'s used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

', 'DataSource$SecretArn' => '

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

', 'DataSourceCredentials$SecretArn' => '

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

', ], ], 'SectionAfterPageBreak' => [ 'base' => '

The configuration of a page break after a section.

', 'refs' => [ 'BodySectionRepeatPageBreakConfiguration$After' => NULL, 'SectionPageBreakConfiguration$After' => '

The configuration of a page break after a section.

', ], ], 'SectionBasedLayoutCanvasSizeOptions' => [ 'base' => '

The options for the canvas of a section-based layout.

', 'refs' => [ 'DefaultSectionBasedLayoutConfiguration$CanvasSizeOptions' => '

Determines the screen canvas size options for a section-based layout.

', 'SectionBasedLayoutConfiguration$CanvasSizeOptions' => '

The options for the canvas of a section-based layout.

', ], ], 'SectionBasedLayoutConfiguration' => [ 'base' => '

The configuration for a section-based layout.

', 'refs' => [ 'LayoutConfiguration$SectionBasedLayout' => '

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

', ], ], 'SectionBasedLayoutPaperCanvasSizeOptions' => [ 'base' => '

The options for a paper canvas of a section-based layout.

', 'refs' => [ 'SectionBasedLayoutCanvasSizeOptions$PaperCanvasSizeOptions' => '

The options for a paper canvas of a section-based layout.

', ], ], 'SectionLayoutConfiguration' => [ 'base' => '

The layout configuration of a section.

', 'refs' => [ 'BodySectionContent$Layout' => '

The layout configuration of a body section.

', 'HeaderFooterSectionConfiguration$Layout' => '

The layout configuration of the header or footer section.

', ], ], 'SectionPageBreakConfiguration' => [ 'base' => '

The configuration of a page break for a section.

', 'refs' => [ 'BodySectionConfiguration$PageBreakConfiguration' => '

The configuration of a page break for a section.

', ], ], 'SectionPageBreakStatus' => [ 'base' => NULL, 'refs' => [ 'SectionAfterPageBreak$Status' => '

The option that enables or disables a page break at the end of a section.

', ], ], 'SectionStyle' => [ 'base' => '

The options that style a section.

', 'refs' => [ 'BodySectionConfiguration$Style' => '

The style options of a body section.

', 'HeaderFooterSectionConfiguration$Style' => '

The style options of a header or footer section.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIdList$member' => NULL, ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$SecurityGroupIds' => '

A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.

', 'CreateVPCConnectionRequest$SecurityGroupIds' => '

A list of security group IDs for the VPC connection.

', 'UpdateVPCConnectionRequest$SecurityGroupIds' => '

A list of security group IDs for the VPC connection.

', 'VPCConnection$SecurityGroupIds' => '

The Amazon EC2 security group IDs associated with the VPC connection.

', 'VPCConnectionSummary$SecurityGroupIds' => '

The Amazon EC2 security group IDs associated with the VPC connection.

', ], ], 'SelectAllValueOptions' => [ 'base' => NULL, 'refs' => [ 'DestinationParameterValueConfiguration$SelectAllValueOptions' => '

The configuration that selects all options.

', ], ], 'SelectedFieldList' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedFields' => '

Chooses the fields that are filtered in CustomActionFilterOperation.

', ], ], 'SelectedFieldOptions' => [ 'base' => NULL, 'refs' => [ 'FilterOperationSelectedFieldsConfiguration$SelectedFieldOptions' => '

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

Valid values are defined as follows:

', ], ], 'SelectedSheetsFilterScopeConfiguration' => [ 'base' => '

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'FilterScopeConfiguration$SelectedSheets' => '

The configuration for applying a filter to specific sheets.

', ], ], 'SelectedTooltipType' => [ 'base' => NULL, 'refs' => [ 'TooltipOptions$SelectedTooltipType' => '

The selected type for the tooltip. Choose one of the following options:

', ], ], 'SemanticEntityType' => [ 'base' => '

A structure that represents a semantic entity type.

', 'refs' => [ 'TopicNamedEntity$SemanticEntityType' => '

The type of named entity that a topic represents.

', ], ], 'SemanticType' => [ 'base' => '

A structure that represents a semantic type.

', 'refs' => [ 'TopicCalculatedField$SemanticType' => '

The semantic type.

', 'TopicColumn$SemanticType' => '

The semantic type of data contained in the column.

', ], ], 'SensitiveDouble' => [ 'base' => NULL, 'refs' => [ 'DecimalValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'ReferenceLineStaticDataConfiguration$Value' => '

The double input of the static data.

', 'SensitiveDoubleList$member' => NULL, ], ], 'SensitiveDoubleList' => [ 'base' => NULL, 'refs' => [ 'DecimalParameter$Values' => '

The values for the decimal parameter.

', ], ], 'SensitiveDoubleObject' => [ 'base' => NULL, 'refs' => [ 'DecimalDefaultValueList$member' => NULL, ], ], 'SensitiveLong' => [ 'base' => NULL, 'refs' => [ 'IntegerValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'SensitiveLongList$member' => NULL, ], ], 'SensitiveLongList' => [ 'base' => NULL, 'refs' => [ 'IntegerParameter$Values' => '

The values for the integer parameter.

', ], ], 'SensitiveLongObject' => [ 'base' => NULL, 'refs' => [ 'IntegerDefaultValueList$member' => NULL, ], ], 'SensitiveS3Uri' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportSourceDescription$Body' => '

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

', 'DescribeAssetBundleExportJobResponse$DownloadUrl' => '

The URL to download the exported asset bundle data from.

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

This URL can\'t be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

', 'SnapshotJobS3Result$S3Uri' => '

The Amazon S3 Uri.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'DataFieldSeriesItem$FieldValue' => '

The field value of the field that you are setting the axis binding to.

', 'SemanticType$TruthyCellValue' => '

The semantic type truthy cell value.

', 'SemanticType$FalseyCellValue' => '

The semantic type falsey cell value.

', 'SensitiveStringList$member' => NULL, 'StringValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', ], ], 'SensitiveStringList' => [ 'base' => NULL, 'refs' => [ 'SemanticType$TruthyCellValueSynonyms' => '

The other names or aliases for the true cell value.

', 'SemanticType$FalseyCellValueSynonyms' => '

The other names or aliases for the false cell value.

', 'StringParameter$Values' => '

The values of a string parameter.

', ], ], 'SensitiveStringObject' => [ 'base' => NULL, 'refs' => [ 'StringDefaultValueList$member' => NULL, ], ], 'SensitiveTimestamp' => [ 'base' => NULL, 'refs' => [ 'DateTimeDefaultValueList$member' => NULL, 'DateTimeValueWhenUnsetConfiguration$CustomValue' => '

A custom value that\'s used when the value of a parameter isn\'t set.

', 'SensitiveTimestampList$member' => NULL, ], ], 'SensitiveTimestampList' => [ 'base' => NULL, 'refs' => [ 'DateTimeParameter$Values' => '

The values for the date-time parameter.

', ], ], 'SeriesItem' => [ 'base' => '

The series item configuration of a line chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'SeriesItemList$member' => NULL, ], ], 'SeriesItemList' => [ 'base' => NULL, 'refs' => [ 'LineChartConfiguration$Series' => '

The series item configuration of a line chart.

', ], ], 'ServiceNowParameters' => [ 'base' => '

The parameters for ServiceNow.

', 'refs' => [ 'DataSourceParameters$ServiceNowParameters' => '

The parameters for ServiceNow.

', ], ], 'ServiceType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedTargetsByService$Service' => '

The name of the Amazon Web Services service.

', 'DeleteIdentityPropagationConfigRequest$Service' => '

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

', 'UpdateIdentityPropagationConfigRequest$Service' => '

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

', ], ], 'SessionLifetimeInMinutes' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

', 'GenerateEmbedUrlForRegisteredUserRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

', 'GetDashboardEmbedUrlRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

', 'GetSessionEmbedUrlRequest$SessionLifetimeInMinutes' => '

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

', ], ], 'SessionLifetimeInMinutesInvalidException' => [ 'base' => '

The number of minutes specified for the lifetime of a session isn\'t valid. The session lifetime must be 15-600 minutes.

', 'refs' => [], ], 'SessionTag' => [ 'base' => '

The key-value pair used for the row-level security tags feature.

', 'refs' => [ 'SessionTagList$member' => NULL, ], ], 'SessionTagKey' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$TagKey' => '

The unique key for a tag.

', 'RowLevelPermissionTagRuleConfiguration$member' => NULL, 'SessionTag$Key' => '

The key for the tag.

', 'SessionTagKeyList$member' => NULL, ], ], 'SessionTagKeyList' => [ 'base' => NULL, 'refs' => [ 'SnapshotAnonymousUserRedacted$RowLevelPermissionTagKeys' => '

The tag keys for the RowLevelPermissionTags.

', ], ], 'SessionTagList' => [ 'base' => NULL, 'refs' => [ 'GenerateEmbedUrlForAnonymousUserRequest$SessionTags' => '

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

', 'SnapshotAnonymousUser$RowLevelPermissionTags' => '

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.

', ], ], 'SessionTagValue' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionTagRule$MatchAllValue' => '

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

', 'SessionTag$Value' => '

The value that you want to assign the tag.

', ], ], 'SetParameterValueConfiguration' => [ 'base' => '

The configuration of adding parameters in action.

', 'refs' => [ 'SetParameterValueConfigurationList$member' => NULL, ], ], 'SetParameterValueConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CustomActionSetParametersOperation$ParameterValueConfigurations' => '

The parameter that determines the value configuration.

', ], ], 'ShapeConditionalFormat' => [ 'base' => '

The shape conditional formatting of a filled map visual.

', 'refs' => [ 'FilledMapShapeConditionalFormatting$Format' => '

The conditional formatting that determines the background color of a filled map\'s shape.

', ], ], 'SharedViewConfigurations' => [ 'base' => '

The shared view settings of an embedded dashboard.

', 'refs' => [ 'AnonymousUserDashboardFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', 'RegisteredUserConsoleFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', 'RegisteredUserDashboardFeatureConfigurations$SharedView' => '

The shared view settings of an embedded dashboard.

', ], ], 'SharingModel' => [ 'base' => NULL, 'refs' => [ 'CreateFolderRequest$SharingModel' => '

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

', 'Folder$SharingModel' => '

The sharing scope of the folder.

', 'FolderSummary$SharingModel' => '

The sharing scope of the folder.

', ], ], 'Sheet' => [ 'base' => '

A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

', 'refs' => [ 'SheetList$member' => NULL, ], ], 'SheetContentType' => [ 'base' => NULL, 'refs' => [ 'DefaultNewSheetConfiguration$SheetContentType' => '

The option that determines the sheet content type.

', 'SheetDefinition$ContentType' => '

The layout content type of the sheet. Choose one of the following options:

', ], ], 'SheetControlDateTimePickerType' => [ 'base' => NULL, 'refs' => [ 'DefaultDateTimePickerControlOptions$Type' => '

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

', 'FilterDateTimePickerControl$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', ], ], 'SheetControlInfoIconLabelOptions' => [ 'base' => '

A control to display info icons for filters and parameters.

', 'refs' => [ 'DateTimePickerControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'DropDownControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'ListControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'RelativeDateTimeControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'SliderControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'TextAreaControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', 'TextFieldControlDisplayOptions$InfoIconLabelOptions' => '

The configuration of info icon label options.

', ], ], 'SheetControlInfoIconText' => [ 'base' => NULL, 'refs' => [ 'SheetControlInfoIconLabelOptions$InfoIconText' => '

The text content of info icon.

', ], ], 'SheetControlLayout' => [ 'base' => '

A grid layout to define the placement of sheet control.

', 'refs' => [ 'SheetControlLayoutList$member' => NULL, ], ], 'SheetControlLayoutConfiguration' => [ 'base' => '

The configuration that determines the elements and canvas size options of sheet control.

', 'refs' => [ 'SheetControlLayout$Configuration' => '

The configuration that determines the elements and canvas size options of sheet control.

', ], ], 'SheetControlLayoutList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$SheetControlLayouts' => '

The control layouts of the sheet.

', ], ], 'SheetControlListType' => [ 'base' => NULL, 'refs' => [ 'DefaultFilterDropDownControlOptions$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', 'DefaultFilterListControlOptions$Type' => '

The type of the DefaultFilterListControlOptions. Choose one of the following options:

', 'FilterDropDownControl$Type' => '

The type of the FilterDropDownControl. Choose one of the following options:

', 'FilterListControl$Type' => '

The type of the FilterListControl. Choose one of the following options:

', 'ParameterDropDownControl$Type' => '

The type parameter name of the ParameterDropDownControl.

', 'ParameterListControl$Type' => '

The type of ParameterListControl.

', ], ], 'SheetControlSliderType' => [ 'base' => NULL, 'refs' => [ 'DefaultSliderControlOptions$Type' => '

The type of the DefaultSliderControlOptions. Choose one of the following options:

', 'FilterSliderControl$Type' => '

The type of the FilterSliderControl. Choose one of the following options:

', ], ], 'SheetControlTitle' => [ 'base' => NULL, 'refs' => [ 'DefaultFilterControlConfiguration$Title' => '

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

', 'FilterDateTimePickerControl$Title' => '

The title of the FilterDateTimePickerControl.

', 'FilterDropDownControl$Title' => '

The title of the FilterDropDownControl.

', 'FilterListControl$Title' => '

The title of the FilterListControl.

', 'FilterRelativeDateTimeControl$Title' => '

The title of the FilterTextAreaControl.

', 'FilterSliderControl$Title' => '

The title of the FilterSliderControl.

', 'FilterTextAreaControl$Title' => '

The title of the FilterTextAreaControl.

', 'FilterTextFieldControl$Title' => '

The title of the FilterTextFieldControl.

', 'ParameterDateTimePickerControl$Title' => '

The title of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$Title' => '

The title of the ParameterDropDownControl.

', 'ParameterListControl$Title' => '

The title of the ParameterListControl.

', 'ParameterSliderControl$Title' => '

The title of the ParameterSliderControl.

', 'ParameterTextAreaControl$Title' => '

The title of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$Title' => '

The title of the ParameterTextFieldControl.

', ], ], 'SheetControlsOption' => [ 'base' => '

Sheet controls option.

', 'refs' => [ 'DashboardPublishOptions$SheetControlsOption' => '

Sheet controls option.

', ], ], 'SheetDefinition' => [ 'base' => '

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

', 'refs' => [ 'SheetDefinitionList$member' => NULL, ], ], 'SheetDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AnalysisDefinition$Sheets' => '

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

', 'DashboardVersionDefinition$Sheets' => '

An array of sheet definitions for a dashboard.

', 'TemplateVersionDefinition$Sheets' => '

An array of sheet definitions for a template.

', ], ], 'SheetDescription' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Description' => '

A description of the sheet.

', ], ], 'SheetElementConfigurationOverrides' => [ 'base' => '

The override configuration of the rendering rules of a sheet.

', 'refs' => [ 'SheetElementRenderingRule$ConfigurationOverrides' => '

The override configuration of the rendering rules of a sheet.

', ], ], 'SheetElementRenderingRule' => [ 'base' => '

The rendering rules of a sheet that uses a free-form layout.

', 'refs' => [ 'SheetElementRenderingRuleList$member' => NULL, ], ], 'SheetElementRenderingRuleList' => [ 'base' => NULL, 'refs' => [ 'FreeFormLayoutElement$RenderingRules' => '

The rendering rules that determine when an element should be displayed within a free-form layout.

', ], ], 'SheetLayoutElementMaximizationOption' => [ 'base' => '

The sheet layout maximization options of a dashbaord.

', 'refs' => [ 'DashboardPublishOptions$SheetLayoutElementMaximizationOption' => '

The sheet layout maximization options of a dashbaord.

', ], ], 'SheetList' => [ 'base' => NULL, 'refs' => [ 'Analysis$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', 'DashboardVersion$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', 'TemplateVersion$Sheets' => '

A list of the associated sheets with the unique identifier and name of each sheet.

', ], ], 'SheetName' => [ 'base' => NULL, 'refs' => [ 'Sheet$Name' => '

The name of a sheet. This name is displayed on the sheet\'s tab in the Amazon QuickSight console.

', 'SheetDefinition$Name' => '

The name of the sheet. This name is displayed on the sheet\'s tab in the Amazon QuickSight console.

', ], ], 'SheetStyle' => [ 'base' => '

The theme display options for sheets.

', 'refs' => [ 'ThemeConfiguration$Sheet' => '

Display options related to sheets.

', ], ], 'SheetTextBox' => [ 'base' => '

A text box.

', 'refs' => [ 'SheetTextBoxList$member' => NULL, ], ], 'SheetTextBoxContent' => [ 'base' => NULL, 'refs' => [ 'SheetTextBox$Content' => '

The content that is displayed in the text box.

', ], ], 'SheetTextBoxList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$TextBoxes' => '

The text boxes that are on a sheet.

', ], ], 'SheetTitle' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Title' => '

The title of the sheet.

', ], ], 'SheetVisualScopingConfiguration' => [ 'base' => '

The filter that is applied to the options.

', 'refs' => [ 'SheetVisualScopingConfigurations$member' => NULL, ], ], 'SheetVisualScopingConfigurations' => [ 'base' => NULL, 'refs' => [ 'SelectedSheetsFilterScopeConfiguration$SheetVisualScopingConfigurations' => '

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

', ], ], 'ShortFormatText' => [ 'base' => '

The text format for the title.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualTitleLabelOptions$FormatText' => '

The short text format of the title label, such as plain text or rich text.

', ], ], 'ShortPlainText' => [ 'base' => NULL, 'refs' => [ 'ShortFormatText$PlainText' => '

Plain text format.

', ], ], 'ShortRestrictiveResourceId' => [ 'base' => NULL, 'refs' => [ 'AdditionalDashboardIdList$member' => NULL, 'Analysis$AnalysisId' => '

The ID of the analysis.

', 'AnalysisSummary$AnalysisId' => '

The ID of the analysis. This ID displays in the URL.

', 'AnonymousUserDashboardEmbeddingConfiguration$InitialDashboardId' => '

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.

', 'AssetBundleExportJobSummary$AssetBundleExportJobId' => '

The ID of the export job.

', 'AssetBundleImportJobSummary$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'BarChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'BodySectionConfiguration$SectionId' => '

The unique identifier of a body section.

', 'BoxPlotVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'CategoryFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'ComboChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'CreateAnalysisRequest$AnalysisId' => '

The ID for the analysis that you\'re creating. This ID displays in the URL of the analysis.

', 'CreateAnalysisResponse$AnalysisId' => '

The ID of the analysis.

', 'CreateDashboardRequest$DashboardId' => '

The ID for the dashboard, also added to the IAM policy.

', 'CreateDashboardResponse$DashboardId' => '

The ID for the dashboard.

', 'CreateTemplateAliasRequest$TemplateId' => '

An ID for the template.

', 'CreateTemplateRequest$TemplateId' => '

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

', 'CreateTemplateResponse$TemplateId' => '

The ID of the template.

', 'CreateThemeAliasRequest$ThemeId' => '

An ID for the theme alias.

', 'CreateThemeRequest$ThemeId' => '

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

', 'CreateThemeRequest$BaseThemeId' => '

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

', 'CreateThemeResponse$ThemeId' => '

The ID of the theme.

', 'CustomContentVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'Dashboard$DashboardId' => '

Dashboard ID.

', 'DashboardSummary$DashboardId' => '

Dashboard ID.

', 'DashboardVisualId$DashboardId' => '

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.

', 'DashboardVisualId$SheetId' => '

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.

', 'DashboardVisualId$VisualId' => '

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.

', 'DeleteAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re deleting.

', 'DeleteAnalysisResponse$AnalysisId' => '

The ID of the deleted analysis.

', 'DeleteDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'DeleteDashboardResponse$DashboardId' => '

The ID of the dashboard.

', 'DeleteTemplateAliasRequest$TemplateId' => '

The ID for the template that the specified alias is for.

', 'DeleteTemplateAliasResponse$TemplateId' => '

An ID for the template associated with the deletion.

', 'DeleteTemplateRequest$TemplateId' => '

An ID for the template you want to delete.

', 'DeleteTemplateResponse$TemplateId' => '

An ID for the template.

', 'DeleteThemeAliasRequest$ThemeId' => '

The ID for the theme that the specified alias is for.

', 'DeleteThemeAliasResponse$ThemeId' => '

An ID for the theme associated with the deletion.

', 'DeleteThemeRequest$ThemeId' => '

An ID for the theme that you want to delete.

', 'DeleteThemeResponse$ThemeId' => '

An ID for the theme.

', 'DescribeAnalysisDefinitionRequest$AnalysisId' => '

The ID of the analysis that you\'re describing. The ID is part of the URL of the analysis.

', 'DescribeAnalysisDefinitionResponse$AnalysisId' => '

The ID of the analysis described.

', 'DescribeAnalysisPermissionsRequest$AnalysisId' => '

The ID of the analysis whose permissions you\'re describing. The ID is part of the analysis URL.

', 'DescribeAnalysisPermissionsResponse$AnalysisId' => '

The ID of the analysis whose permissions you\'re describing.

', 'DescribeAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re describing. The ID is part of the URL of the analysis.

', 'DescribeAssetBundleExportJobRequest$AssetBundleExportJobId' => '

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

', 'DescribeAssetBundleExportJobResponse$AssetBundleExportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

', 'DescribeAssetBundleImportJobRequest$AssetBundleImportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

', 'DescribeAssetBundleImportJobResponse$AssetBundleImportJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

', 'DescribeDashboardDefinitionRequest$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardDefinitionResponse$DashboardId' => '

The ID of the dashboard described.

', 'DescribeDashboardPermissionsRequest$DashboardId' => '

The ID for the dashboard, also added to the IAM policy.

', 'DescribeDashboardPermissionsResponse$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'DescribeDashboardSnapshotJobRequest$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobRequest$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResponse$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobResponse$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeDashboardSnapshotJobResultRequest$DashboardId' => '

The ID of the dashboard that you have started a snapshot job for.

', 'DescribeDashboardSnapshotJobResultRequest$SnapshotJobId' => '

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'DescribeTemplateAliasRequest$TemplateId' => '

The ID for the template.

', 'DescribeTemplateDefinitionRequest$TemplateId' => '

The ID of the template that you\'re describing.

', 'DescribeTemplateDefinitionResponse$TemplateId' => '

The ID of the template described.

', 'DescribeTemplatePermissionsRequest$TemplateId' => '

The ID for the template.

', 'DescribeTemplatePermissionsResponse$TemplateId' => '

The ID for the template.

', 'DescribeTemplateRequest$TemplateId' => '

The ID for the template.

', 'DescribeThemeAliasRequest$ThemeId' => '

The ID for the theme.

', 'DescribeThemePermissionsRequest$ThemeId' => '

The ID for the theme that you want to describe permissions for.

', 'DescribeThemePermissionsResponse$ThemeId' => '

The ID for the theme.

', 'DescribeThemeRequest$ThemeId' => '

The ID for the theme.

', 'EmptyVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'FilledMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'FilterCrossSheetControl$FilterControlId' => '

The ID of the FilterCrossSheetControl.

', 'FilterCrossSheetControl$SourceFilterId' => '

The source filter ID of the FilterCrossSheetControl.

', 'FilterDateTimePickerControl$FilterControlId' => '

The ID of the FilterDateTimePickerControl.

', 'FilterDateTimePickerControl$SourceFilterId' => '

The source filter ID of the FilterDateTimePickerControl.

', 'FilterDropDownControl$FilterControlId' => '

The ID of the FilterDropDownControl.

', 'FilterDropDownControl$SourceFilterId' => '

The source filter ID of the FilterDropDownControl.

', 'FilterGroup$FilterGroupId' => '

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

', 'FilterListControl$FilterControlId' => '

The ID of the FilterListControl.

', 'FilterListControl$SourceFilterId' => '

The source filter ID of the FilterListControl.

', 'FilterRelativeDateTimeControl$FilterControlId' => '

The ID of the FilterTextAreaControl.

', 'FilterRelativeDateTimeControl$SourceFilterId' => '

The source filter ID of the FilterTextAreaControl.

', 'FilterSliderControl$FilterControlId' => '

The ID of the FilterSliderControl.

', 'FilterSliderControl$SourceFilterId' => '

The source filter ID of the FilterSliderControl.

', 'FilterTextAreaControl$FilterControlId' => '

The ID of the FilterTextAreaControl.

', 'FilterTextAreaControl$SourceFilterId' => '

The source filter ID of the FilterTextAreaControl.

', 'FilterTextFieldControl$FilterControlId' => '

The ID of the FilterTextFieldControl.

', 'FilterTextFieldControl$SourceFilterId' => '

The source filter ID of the FilterTextFieldControl.

', 'FilteredVisualsList$member' => NULL, 'ForecastComputation$ComputationId' => '

The ID for a computation.

', 'FreeFormLayoutElement$ElementId' => '

A unique identifier for an element within a free-form layout.

', 'FunnelChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'GaugeChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'GeospatialMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'GetDashboardEmbedUrlRequest$DashboardId' => '

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

', 'GridLayoutElement$ElementId' => '

A unique identifier for an element within a grid layout.

', 'GrowthRateComputation$ComputationId' => '

The ID for a computation.

', 'HeaderFooterSectionConfiguration$SectionId' => '

The unique identifier of the header or footer section.

', 'HeatMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'HistogramVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'InsightVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'KPIVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'LineChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'ListDashboardVersionsRequest$DashboardId' => '

The ID for the dashboard.

', 'ListTemplateAliasesRequest$TemplateId' => '

The ID for the template.

', 'ListTemplateVersionsRequest$TemplateId' => '

The ID for the template.

', 'ListThemeAliasesRequest$ThemeId' => '

The ID for the theme.

', 'ListThemeVersionsRequest$ThemeId' => '

The ID for the theme.

', 'LocalNavigationConfiguration$TargetSheetId' => '

The sheet that is targeted for navigation in the same analysis.

', 'MaximumMinimumComputation$ComputationId' => '

The ID for a computation.

', 'MetricComparisonComputation$ComputationId' => '

The ID for a computation.

', 'NestedFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'NonRepeatingVisualsList$member' => NULL, 'NumericEqualityFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'NumericRangeFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'ParameterDateTimePickerControl$ParameterControlId' => '

The ID of the ParameterDateTimePickerControl.

', 'ParameterDropDownControl$ParameterControlId' => '

The ID of the ParameterDropDownControl.

', 'ParameterListControl$ParameterControlId' => '

The ID of the ParameterListControl.

', 'ParameterSliderControl$ParameterControlId' => '

The ID of the ParameterSliderControl.

', 'ParameterTextAreaControl$ParameterControlId' => '

The ID of the ParameterTextAreaControl.

', 'ParameterTextFieldControl$ParameterControlId' => '

The ID of the ParameterTextFieldControl.

', 'PeriodOverPeriodComputation$ComputationId' => '

The ID for a computation.

', 'PeriodToDateComputation$ComputationId' => '

The ID for a computation.

', 'PieChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'PivotTableVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'RadarChartVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'RegisteredUserDashboardEmbeddingConfiguration$InitialDashboardId' => '

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.

', 'RelativeDatesFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'RestoreAnalysisRequest$AnalysisId' => '

The ID of the analysis that you\'re restoring.

', 'RestoreAnalysisResponse$AnalysisId' => '

The ID of the analysis that you\'re restoring.

', 'SankeyDiagramVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'ScatterPlotVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'Sheet$SheetId' => '

The unique identifier associated with a sheet.

', 'SheetDefinition$SheetId' => '

The unique identifier of a sheet.

', 'SheetTextBox$SheetTextBoxId' => '

The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

', 'SheetVisualScopingConfiguration$SheetId' => '

The selected sheet that the filter is applied to.

', 'SnapshotFileSheetSelection$SheetId' => '

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

', 'SnapshotFileSheetSelectionVisualIdList$member' => NULL, 'StartAssetBundleExportJobRequest$AssetBundleExportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleExportJobResponse$AssetBundleExportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleImportJobRequest$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartAssetBundleImportJobResponse$AssetBundleImportJobId' => '

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

', 'StartDashboardSnapshotJobRequest$DashboardId' => '

The ID of the dashboard that you want to start a snapshot job for.

', 'StartDashboardSnapshotJobRequest$SnapshotJobId' => '

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

', 'StartDashboardSnapshotJobResponse$SnapshotJobId' => '

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

', 'TableVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'TargetVisualList$member' => NULL, 'Template$TemplateId' => '

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'TemplateSummary$TemplateId' => '

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'Theme$ThemeId' => '

The identifier that the user gives to the theme.

', 'ThemeSummary$ThemeId' => '

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ThemeVersion$BaseThemeId' => '

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

', 'TimeEqualityFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TimeRangeFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TopBottomFilter$FilterId' => '

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

', 'TopBottomMoversComputation$ComputationId' => '

The ID for a computation.

', 'TopBottomRankedComputation$ComputationId' => '

The ID for a computation.

', 'TotalAggregationComputation$ComputationId' => '

The ID for a computation.

', 'TreeMapVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', 'UniqueValuesComputation$ComputationId' => '

The ID for a computation.

', 'UpdateAnalysisPermissionsRequest$AnalysisId' => '

The ID of the analysis whose permissions you\'re updating. The ID is part of the analysis URL.

', 'UpdateAnalysisPermissionsResponse$AnalysisId' => '

The ID of the analysis that you updated permissions for.

', 'UpdateAnalysisRequest$AnalysisId' => '

The ID for the analysis that you\'re updating. This ID displays in the URL of the analysis.

', 'UpdateAnalysisResponse$AnalysisId' => '

The ID of the analysis.

', 'UpdateDashboardLinksRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPermissionsRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPermissionsResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPublishedVersionRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardPublishedVersionResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardRequest$DashboardId' => '

The ID for the dashboard.

', 'UpdateDashboardResponse$DashboardId' => '

The ID for the dashboard.

', 'UpdateTemplateAliasRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplatePermissionsRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplatePermissionsResponse$TemplateId' => '

The ID for the template.

', 'UpdateTemplateRequest$TemplateId' => '

The ID for the template.

', 'UpdateTemplateResponse$TemplateId' => '

The ID for the template.

', 'UpdateThemeAliasRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemePermissionsRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemePermissionsResponse$ThemeId' => '

The ID for the theme.

', 'UpdateThemeRequest$ThemeId' => '

The ID for the theme.

', 'UpdateThemeRequest$BaseThemeId' => '

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

', 'UpdateThemeResponse$ThemeId' => '

The ID for the theme.

', 'VisualCustomAction$CustomActionId' => '

The ID of the VisualCustomAction.

', 'WaterfallVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

', 'WordCloudVisual$VisualId' => '

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

', ], ], 'ShortRichText' => [ 'base' => NULL, 'refs' => [ 'ShortFormatText$RichText' => '

Rich text. Examples of rich text include bold, underline, and italics.

', ], ], 'SignupResponse' => [ 'base' => '

A SignupResponse object that contains a summary of a newly created account.

', 'refs' => [ 'CreateAccountSubscriptionResponse$SignupResponse' => '

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

', ], ], 'SimpleAttributeAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'AttributeAggregationFunction$SimpleAttributeAggregation' => '

The built-in aggregation functions for attributes.

', ], ], 'SimpleClusterMarker' => [ 'base' => '

The simple cluster marker of the cluster marker.

', 'refs' => [ 'ClusterMarker$SimpleClusterMarker' => '

The simple cluster marker of the cluster marker.

', ], ], 'SimpleNumericalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'NumericalAggregationFunction$SimpleNumericalAggregation' => '

Built-in aggregation functions for numerical values.

', ], ], 'SimpleTotalAggregationFunction' => [ 'base' => NULL, 'refs' => [ 'TotalAggregationFunction$SimpleTotalAggregationFunction' => '

A built in aggregation function for total values.

', ], ], 'SingleAxisOptions' => [ 'base' => '

The settings of a chart\'s single axis configuration.

', 'refs' => [ 'ComboChartConfiguration$SingleAxisOptions' => NULL, 'LineChartConfiguration$SingleAxisOptions' => NULL, ], ], 'SingleYAxisOption' => [ 'base' => NULL, 'refs' => [ 'YAxisOptions$YAxis' => '

The Y axis type to be used in the chart.

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

', ], ], 'SiteBaseUrl' => [ 'base' => NULL, 'refs' => [ 'JiraParameters$SiteBaseUrl' => '

The base URL of the Jira site.

', 'ServiceNowParameters$SiteBaseUrl' => '

URL of the base site.

', ], ], 'SliderControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultSliderControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterSliderControl$DisplayOptions' => '

The display options of a control.

', 'ParameterSliderControl$DisplayOptions' => '

The display options of a control.

', ], ], 'Slot' => [ 'base' => '

The definition for the slot.

', 'refs' => [ 'Slots$member' => NULL, ], ], 'Slots' => [ 'base' => NULL, 'refs' => [ 'TopicTemplate$Slots' => '

The slots for the TopicTemplate.

', ], ], 'SmallMultiplesAxisPlacement' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesAxisProperties$Placement' => '

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

', ], ], 'SmallMultiplesAxisProperties' => [ 'base' => '

Configures the properties of a chart\'s axes that are used by small multiples panels.

', 'refs' => [ 'SmallMultiplesOptions$XAxis' => '

The properties of a small multiples X axis.

', 'SmallMultiplesOptions$YAxis' => '

The properties of a small multiples Y axis.

', ], ], 'SmallMultiplesAxisScale' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesAxisProperties$Scale' => '

Determines whether scale of the axes are shared or independent. The default value is SHARED.

', ], ], 'SmallMultiplesDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'BarChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a bar chart.

', 'LineChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a line chart.

', 'PieChartAggregatedFieldWells$SmallMultiples' => '

The small multiples field well of a pie chart.

', ], ], 'SmallMultiplesOptions' => [ 'base' => '

Options that determine the layout and display options of a chart\'s small multiples.

', 'refs' => [ 'BarChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', 'LineChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', 'PieChartConfiguration$SmallMultiplesOptions' => '

The small multiples setup for the visual.

', ], ], 'SnapshotAnonymousUser' => [ 'base' => '

A structure that contains information on the anonymous user configuration.

', 'refs' => [ 'SnapshotAnonymousUserList$member' => NULL, ], ], 'SnapshotAnonymousUserList' => [ 'base' => NULL, 'refs' => [ 'SnapshotUserConfiguration$AnonymousUsers' => '

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

', ], ], 'SnapshotAnonymousUserRedacted' => [ 'base' => '

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

', 'refs' => [ 'SnapshotAnonymousUserRedactedList$member' => NULL, ], ], 'SnapshotAnonymousUserRedactedList' => [ 'base' => NULL, 'refs' => [ 'SnapshotUserConfigurationRedacted$AnonymousUsers' => '

An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.

', ], ], 'SnapshotConfiguration' => [ 'base' => '

Describes the configuration of the dashboard snapshot.

', 'refs' => [ 'DescribeDashboardSnapshotJobResponse$SnapshotConfiguration' => '

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

', 'StartDashboardSnapshotJobRequest$SnapshotConfiguration' => '

A structure that describes the configuration of the dashboard snapshot.

', ], ], 'SnapshotDestinationConfiguration' => [ 'base' => '

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

', 'refs' => [ 'SnapshotConfiguration$DestinationConfiguration' => '

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

', ], ], 'SnapshotFile' => [ 'base' => '

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

', 'refs' => [ 'SnapshotFileList$member' => NULL, ], ], 'SnapshotFileFormatType' => [ 'base' => NULL, 'refs' => [ 'SnapshotFile$FormatType' => '

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

', ], ], 'SnapshotFileGroup' => [ 'base' => '

A structure that contains the information on the snapshot files.

', 'refs' => [ 'SnapshotFileGroupList$member' => NULL, ], ], 'SnapshotFileGroupList' => [ 'base' => NULL, 'refs' => [ 'SnapshotConfiguration$FileGroups' => '

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

', ], ], 'SnapshotFileList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileGroup$Files' => '

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

', 'SnapshotJobResultFileGroup$Files' => '

A list of SnapshotFile objects.

', ], ], 'SnapshotFileSheetSelection' => [ 'base' => '

A structure that contains information that identifies the snapshot that needs to be generated.

', 'refs' => [ 'SnapshotFileSheetSelectionList$member' => NULL, ], ], 'SnapshotFileSheetSelectionList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFile$SheetSelections' => '

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

', ], ], 'SnapshotFileSheetSelectionScope' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileSheetSelection$SelectionScope' => '

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

', ], ], 'SnapshotFileSheetSelectionVisualIdList' => [ 'base' => NULL, 'refs' => [ 'SnapshotFileSheetSelection$VisualIds' => '

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

', ], ], 'SnapshotJobErrorInfo' => [ 'base' => '

An object that contains information on the error that caused the snapshot job to fail.

', 'refs' => [ 'DescribeDashboardSnapshotJobResultResponse$ErrorInfo' => '

Displays information for the error that caused a job to fail.

', ], ], 'SnapshotJobResult' => [ 'base' => '

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

', 'refs' => [ 'DescribeDashboardSnapshotJobResultResponse$Result' => '

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

', ], ], 'SnapshotJobResultErrorInfo' => [ 'base' => '

Information on the error that caused the snapshot job to fail.

', 'refs' => [ 'SnapshotJobResultErrorInfoList$member' => NULL, ], ], 'SnapshotJobResultErrorInfoList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobS3Result$ErrorInfo' => '

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

', ], ], 'SnapshotJobResultFileGroup' => [ 'base' => '

A structure that contains information on the generated snapshot file groups.

', 'refs' => [ 'SnapshotJobResultFileGroupList$member' => NULL, ], ], 'SnapshotJobResultFileGroupList' => [ 'base' => NULL, 'refs' => [ 'AnonymousUserSnapshotJobResult$FileGroups' => '

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

', ], ], 'SnapshotJobS3Result' => [ 'base' => '

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

', 'refs' => [ 'SnapshotJobS3ResultList$member' => NULL, ], ], 'SnapshotJobS3ResultList' => [ 'base' => NULL, 'refs' => [ 'SnapshotJobResultFileGroup$S3Results' => '

A list of SnapshotJobS3Result objects.

', ], ], 'SnapshotJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDashboardSnapshotJobResponse$JobStatus' => '

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

', 'DescribeDashboardSnapshotJobResultResponse$JobStatus' => '

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

', ], ], 'SnapshotS3DestinationConfiguration' => [ 'base' => '

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

', 'refs' => [ 'SnapshotJobS3Result$S3DestinationConfiguration' => '

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.

', 'SnapshotS3DestinationConfigurationList$member' => NULL, ], ], 'SnapshotS3DestinationConfigurationList' => [ 'base' => NULL, 'refs' => [ 'SnapshotDestinationConfiguration$S3Destinations' => '

A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.

', ], ], 'SnapshotUserConfiguration' => [ 'base' => '

A structure that contains information about the users that the dashboard snapshot is generated for.

', 'refs' => [ 'StartDashboardSnapshotJobRequest$UserConfiguration' => '

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.

', ], ], 'SnapshotUserConfigurationRedacted' => [ 'base' => '

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.

', 'refs' => [ 'DescribeDashboardSnapshotJobResponse$UserConfiguration' => '

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

', ], ], 'SnowflakeParameters' => [ 'base' => '

The parameters for Snowflake.

', 'refs' => [ 'DataSourceParameters$SnowflakeParameters' => '

The parameters for Snowflake.

', ], ], 'SortDirection' => [ 'base' => NULL, 'refs' => [ 'AggregationSortConfiguration$SortDirection' => '

The sort direction of values.

', 'ColumnSort$Direction' => '

The sort direction.

', 'DataPathSort$Direction' => '

Determines the sort direction.

', 'FieldSort$Direction' => '

The sort direction. Choose one of the following options:

', ], ], 'Spacing' => [ 'base' => '

The configuration of spacing (often a margin or padding).

', 'refs' => [ 'SectionBasedLayoutPaperCanvasSizeOptions$PaperMargin' => '

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

', 'SectionStyle$Padding' => '

The spacing between section content and its top, bottom, left, and right edges.

There is no padding by default.

', ], ], 'SparkParameters' => [ 'base' => '

The parameters for Spark.

', 'refs' => [ 'DataSourceParameters$SparkParameters' => '

The parameters for Spark.

', ], ], 'SpecialValue' => [ 'base' => NULL, 'refs' => [ 'CustomColor$SpecialValue' => '

The value of a special data value.

', ], ], 'SqlEndpointPath' => [ 'base' => NULL, 'refs' => [ 'DatabricksParameters$SqlEndpointPath' => '

The HTTP path of the Databricks data source.

', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'CustomSql$SqlQuery' => '

The SQL query.

', ], ], 'SqlServerParameters' => [ 'base' => '

The parameters for SQL Server.

', 'refs' => [ 'DataSourceParameters$SqlServerParameters' => '

The parameters for SQL Server.

', ], ], 'SslProperties' => [ 'base' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$SslProperties' => NULL, 'CreateDataSourceRequest$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', 'DataSource$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', 'UpdateDataSourceRequest$SslProperties' => '

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

', ], ], 'StarburstParameters' => [ 'base' => '

The parameters that are required to connect to a Starburst data source.

', 'refs' => [ 'DataSourceParameters$StarburstParameters' => '

The parameters that are required to connect to a Starburst data source.

', ], ], 'StarburstProductType' => [ 'base' => NULL, 'refs' => [ 'StarburstParameters$ProductType' => '

The product type for the Starburst data source.

', ], ], 'StartAssetBundleExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAssetBundleImportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDashboardSnapshotJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDashboardSnapshotJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatePersistenceConfigurations' => [ 'base' => '

The state perssitence configuration of an embedded dashboard.

', 'refs' => [ 'RegisteredUserConsoleFeatureConfigurations$StatePersistence' => '

The state persistence configurations of an embedded Amazon QuickSight console.

', 'RegisteredUserDashboardFeatureConfigurations$StatePersistence' => '

The state persistence settings of an embedded dashboard.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'RowLevelPermissionDataSet$Status' => '

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

', 'RowLevelPermissionTagConfiguration$Status' => '

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$Status' => '

The HTTP status of the request.

', 'BatchDeleteTopicReviewedAnswerResponse$Status' => '

The HTTP status of the request.

', 'CancelIngestionResponse$Status' => '

The HTTP status of the request.

', 'CreateAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'CreateAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'CreateAnalysisResponse$Status' => '

The HTTP status of the request.

', 'CreateDashboardResponse$Status' => '

The HTTP status of the request.

', 'CreateDataSetResponse$Status' => '

The HTTP status of the request.

', 'CreateDataSourceResponse$Status' => '

The HTTP status of the request.

', 'CreateFolderMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateFolderResponse$Status' => '

The HTTP status of the request.

', 'CreateGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateGroupResponse$Status' => '

The HTTP status of the request.

', 'CreateIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'CreateIngestionResponse$Status' => '

The HTTP status of the request.

', 'CreateNamespaceResponse$Status' => '

The HTTP status of the request.

', 'CreateRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'CreateRoleMembershipResponse$Status' => '

The HTTP status of the request.

', 'CreateTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'CreateTemplateResponse$Status' => '

The HTTP status of the request.

', 'CreateThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'CreateThemeResponse$Status' => '

The HTTP status of the request.

', 'CreateTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'CreateTopicResponse$Status' => '

The HTTP status of the request.

', 'CreateVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'DeleteAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'DeleteAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'DeleteAnalysisResponse$Status' => '

The HTTP status of the request.

', 'DeleteDashboardResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSetResponse$Status' => '

The HTTP status of the request.

', 'DeleteDataSourceResponse$Status' => '

The HTTP status of the request.

', 'DeleteFolderMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteFolderResponse$Status' => '

The HTTP status of the request.

', 'DeleteGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteGroupResponse$Status' => '

The HTTP status of the request.

', 'DeleteIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'DeleteIdentityPropagationConfigResponse$Status' => '

The HTTP status of the request.

', 'DeleteNamespaceResponse$Status' => '

The HTTP status of the request.

', 'DeleteRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DeleteRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'DeleteRoleMembershipResponse$Status' => '

The HTTP status of the request.

', 'DeleteTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'DeleteTemplateResponse$Status' => '

The HTTP status of the request.

', 'DeleteThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'DeleteThemeResponse$Status' => '

The HTTP status of the request.

', 'DeleteTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DeleteTopicResponse$Status' => '

The HTTP status of the request.

', 'DeleteUserByPrincipalIdResponse$Status' => '

The HTTP status of the request.

', 'DeleteUserResponse$Status' => '

The HTTP status of the request.

', 'DeleteVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountSettingsResponse$Status' => '

The HTTP status of the request.

', 'DescribeAccountSubscriptionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeAnalysisResponse$Status' => '

The HTTP status of the request.

', 'DescribeAssetBundleExportJobResponse$Status' => '

The HTTP status of the response.

', 'DescribeAssetBundleImportJobResponse$Status' => '

The HTTP status of the response.

', 'DescribeDashboardDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeDashboardPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDashboardResponse$Status' => '

The HTTP status of this request.

', 'DescribeDashboardSnapshotJobResponse$Status' => '

The HTTP status of the request

', 'DescribeDashboardSnapshotJobResultResponse$Status' => '

The HTTP status of the request

', 'DescribeDataSetPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSetResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSourcePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeDataSourceResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderResolvedPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeFolderResponse$Status' => '

The HTTP status of the request.

', 'DescribeGroupMembershipResponse$Status' => '

The HTTP status of the request.

', 'DescribeGroupResponse$Status' => '

The HTTP status of the request.

', 'DescribeIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'DescribeIngestionResponse$Status' => '

The HTTP status of the request.

', 'DescribeIpRestrictionResponse$Status' => '

The HTTP status of the request.

', 'DescribeKeyRegistrationResponse$Status' => '

The HTTP status of the request.

', 'DescribeNamespaceResponse$Status' => '

The HTTP status of the request.

', 'DescribeRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DescribeRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateDefinitionResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplatePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeTemplateResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemePermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeThemeResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicPermissionsResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicRefreshResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'DescribeTopicResponse$Status' => '

The HTTP status of the request.

', 'DescribeUserResponse$Status' => '

The HTTP status of the request.

', 'DescribeVPCConnectionResponse$Status' => '

The HTTP status of the request.

', 'FailedKeyRegistrationEntry$StatusCode' => '

The HTTP status of a FailedKeyRegistrationEntry error.

', 'GenerateEmbedUrlForAnonymousUserResponse$Status' => '

The HTTP status of the request.

', 'GenerateEmbedUrlForRegisteredUserResponse$Status' => '

The HTTP status of the request.

', 'GetDashboardEmbedUrlResponse$Status' => '

The HTTP status of the request.

', 'GetSessionEmbedUrlResponse$Status' => '

The HTTP status of the request.

', 'ListAnalysesResponse$Status' => '

The HTTP status of the request.

', 'ListAssetBundleExportJobsResponse$Status' => '

The HTTP status of the request.

', 'ListAssetBundleImportJobsResponse$Status' => '

The HTTP status of the response.

', 'ListDashboardVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListDashboardsResponse$Status' => '

The HTTP status of the request.

', 'ListDataSetsResponse$Status' => '

The HTTP status of the request.

', 'ListDataSourcesResponse$Status' => '

The HTTP status of the request.

', 'ListFolderMembersResponse$Status' => '

The HTTP status of the request.

', 'ListFoldersResponse$Status' => '

The HTTP status of the request.

', 'ListGroupMembershipsResponse$Status' => '

The HTTP status of the request.

', 'ListGroupsResponse$Status' => '

The HTTP status of the request.

', 'ListIAMPolicyAssignmentsForUserResponse$Status' => '

The HTTP status of the request.

', 'ListIAMPolicyAssignmentsResponse$Status' => '

The HTTP status of the request.

', 'ListIdentityPropagationConfigsResponse$Status' => '

The HTTP status of the request.

', 'ListIngestionsResponse$Status' => '

The HTTP status of the request.

', 'ListNamespacesResponse$Status' => '

The HTTP status of the request.

', 'ListRefreshSchedulesResponse$Status' => '

The HTTP status of the request.

', 'ListRoleMembershipsResponse$Status' => '

The HTTP status of the request.

', 'ListTagsForResourceResponse$Status' => '

The HTTP status of the request.

', 'ListTemplateAliasesResponse$Status' => '

The HTTP status of the request.

', 'ListTemplateVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListTemplatesResponse$Status' => '

The HTTP status of the request.

', 'ListThemeAliasesResponse$Status' => '

The HTTP status of the request.

', 'ListThemeVersionsResponse$Status' => '

The HTTP status of the request.

', 'ListThemesResponse$Status' => '

The HTTP status of the request.

', 'ListTopicRefreshSchedulesResponse$Status' => '

The HTTP status of the request.

', 'ListTopicReviewedAnswersResponse$Status' => '

The HTTP status of the request.

', 'ListTopicsResponse$Status' => '

The HTTP status of the request.

', 'ListUserGroupsResponse$Status' => '

The HTTP status of the request.

', 'ListUsersResponse$Status' => '

The HTTP status of the request.

', 'ListVPCConnectionsResponse$Status' => '

The HTTP status of the request.

', 'PutDataSetRefreshPropertiesResponse$Status' => '

The HTTP status of the request.

', 'RegisterUserResponse$Status' => '

The HTTP status of the request.

', 'RestoreAnalysisResponse$Status' => '

The HTTP status of the request.

', 'SearchAnalysesResponse$Status' => '

The HTTP status of the request.

', 'SearchDashboardsResponse$Status' => '

The HTTP status of the request.

', 'SearchDataSetsResponse$Status' => '

The HTTP status of the request.

', 'SearchDataSourcesResponse$Status' => '

The HTTP status of the request.

', 'SearchFoldersResponse$Status' => '

The HTTP status of the request.

', 'SearchGroupsResponse$Status' => '

The HTTP status of the request.

', 'StartAssetBundleExportJobResponse$Status' => '

The HTTP status of the response.

', 'StartAssetBundleImportJobResponse$Status' => '

The HTTP status of the response.

', 'StartDashboardSnapshotJobResponse$Status' => '

The HTTP status of the request

', 'SuccessfulKeyRegistrationEntry$StatusCode' => '

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

', 'TagResourceResponse$Status' => '

The HTTP status of the request.

', 'UntagResourceResponse$Status' => '

The HTTP status of the request.

', 'UpdateAccountCustomizationResponse$Status' => '

The HTTP status of the request.

', 'UpdateAccountSettingsResponse$Status' => '

The HTTP status of the request.

', 'UpdateAnalysisPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateAnalysisResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardLinksResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardPublishedVersionResponse$Status' => '

The HTTP status of the request.

', 'UpdateDashboardResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSetPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSetResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSourcePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateDataSourceResponse$Status' => '

The HTTP status of the request.

', 'UpdateFolderPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateFolderResponse$Status' => '

The HTTP status of the request.

', 'UpdateGroupResponse$Status' => '

The HTTP status of the request.

', 'UpdateIAMPolicyAssignmentResponse$Status' => '

The HTTP status of the request.

', 'UpdateIdentityPropagationConfigResponse$Status' => '

The HTTP status of the request.

', 'UpdateIpRestrictionResponse$Status' => '

The HTTP status of the request.

', 'UpdatePublicSharingSettingsResponse$Status' => '

The HTTP status of the request.

', 'UpdateRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'UpdateRoleCustomPermissionResponse$Status' => '

The HTTP status of the request.

', 'UpdateSPICECapacityConfigurationResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplateAliasResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplatePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateTemplateResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemeAliasResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemePermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateThemeResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicPermissionsResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicRefreshScheduleResponse$Status' => '

The HTTP status of the request.

', 'UpdateTopicResponse$Status' => '

The HTTP status of the request.

', 'UpdateUserResponse$Status' => '

The HTTP status of the request.

', 'UpdateVPCConnectionResponse$Status' => '

The HTTP status of the request.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AccessDeniedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'AccountInfo$AccountName' => '

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.

', 'AccountInfo$NotificationEmail' => '

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

', 'AccountInfo$AuthenticationType' => '

The way that your Amazon QuickSight account is authenticated.

', 'AccountInfo$AccountSubscriptionStatus' => '

The status of your account subscription.

', 'AccountInfo$IAMIdentityCenterInstanceArn' => '

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

', 'AccountSettings$AccountName' => '

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.

', 'AccountSettings$NotificationEmail' => '

The main notification email for your Amazon QuickSight subscription.

', 'ActionList$member' => NULL, 'AnalysisSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$ScheduleId' => '

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

', 'AssetBundleImportJobResourceIdOverrideConfiguration$PrefixForAllResources' => '

An option to request a CloudFormation variable for a prefix to be prepended to each resource\'s ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

', 'AssetOptions$Timezone' => '

Determines the timezone for the analysis.

', 'AttributeAggregationFunction$ValueForMultipleValues' => '

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to \'*\'.

', 'AuthorizedTargetsList$member' => NULL, 'AxisLabelOptions$CustomLabel' => '

The text for the axis label.

', 'BatchCreateTopicReviewedAnswerResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'BatchDeleteTopicReviewedAnswerResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CancelIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'CancelIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CascadingControlSource$SourceSheetControlId' => '

The source sheet control ID of a CascadingControlSource.

', 'ColumnGroupColumnSchema$Name' => '

The name of the column group\'s column schema.

', 'ColumnGroupSchema$Name' => '

The name of the column group schema.

', 'ColumnNameList$member' => NULL, 'ColumnSchema$Name' => '

The name of the column schema.

', 'ColumnSchema$DataType' => '

The data type of the column schema.

', 'ColumnSchema$GeographicRole' => '

The geographic role of the column schema.

', 'ColumnTooltipItem$Label' => '

The label of the tooltip item.

', 'ConcurrentUpdatingException$Message' => NULL, 'ConcurrentUpdatingException$RequestId' => NULL, 'ConflictException$Message' => NULL, 'ConflictException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'CreateAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateAccountSubscriptionRequest$NotificationEmail' => '

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

', 'CreateAccountSubscriptionRequest$ActiveDirectoryName' => '

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

', 'CreateAccountSubscriptionRequest$Realm' => '

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.

', 'CreateAccountSubscriptionRequest$DirectoryId' => '

The ID of the Active Directory that is associated with your Amazon QuickSight account.

', 'CreateAccountSubscriptionRequest$FirstName' => '

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.

', 'CreateAccountSubscriptionRequest$LastName' => '

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.

', 'CreateAccountSubscriptionRequest$EmailAddress' => '

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.

', 'CreateAccountSubscriptionRequest$ContactNumber' => '

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.

', 'CreateAccountSubscriptionRequest$IAMIdentityCenterInstanceArn' => '

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

', 'CreateAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateFolderMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateFolderResponse$RequestId' => '

The request ID for the newly created folder.

', 'CreateGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateIAMPolicyAssignmentResponse$AssignmentId' => '

The ID for the assignment.

', 'CreateIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'CreateIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateNamespaceResponse$CapacityRegion' => '

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

', 'CreateNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'CreateRoleMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTopicRefreshScheduleRequest$DatasetName' => '

The name of the dataset.

', 'CreateTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CreateVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'CustomerManagedKeyUnavailableException$Message' => NULL, 'CustomerManagedKeyUnavailableException$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DashboardSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DataSetConfiguration$Placeholder' => '

Placeholder.

', 'DataSetSearchFilter$Value' => '

The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DataSourceErrorInfo$Message' => '

Error message.

', 'DataSourceSearchFilter$Value' => '

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

', 'DeleteAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteFolderMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteIdentityPropagationConfigResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRefreshScheduleRequest$ScheduleId' => '

The ID of the refresh schedule.

', 'DeleteRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'DeleteRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteRoleMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'DeleteTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteUserByPrincipalIdRequest$PrincipalId' => '

The principal ID of the user.

', 'DeleteUserByPrincipalIdResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DeleteVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAccountSubscriptionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSourcePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderPermissionsRequest$NextToken' => '

A pagination token for the next set of results.

', 'DescribeFolderPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderPermissionsResponse$NextToken' => '

The pagination token for the next set of results, or null if there are no more results.

', 'DescribeFolderResolvedPermissionsRequest$NextToken' => '

A pagination token for the next set of results.

', 'DescribeFolderResolvedPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeFolderResolvedPermissionsResponse$NextToken' => '

A pagination token for the next set of results, or null if there are no more results.

', 'DescribeFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeGroupMembershipResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIngestionRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'DescribeIngestionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeIpRestrictionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeNamespaceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeRefreshScheduleRequest$ScheduleId' => '

The ID of the refresh schedule.

', 'DescribeRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateDefinitionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplatePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicRefreshResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'DescribeTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DescribeVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'DestinationParameterValueConfiguration$SourceParameterName' => '

The source parameter name of the destination parameter.

', 'DomainNotWhitelistedException$Message' => NULL, 'DomainNotWhitelistedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ErrorInfo$Message' => '

Error message.

', 'FailedKeyRegistrationEntry$KeyArn' => '

The ARN of the KMS key that failed to update.

', 'FieldTooltipItem$Label' => '

The label of the tooltip item.

', 'FolderColumnList$member' => NULL, 'FolderSearchFilter$Value' => '

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".

', 'Font$FontFamily' => '

Determines the font family settings.

', 'ForecastComputation$Name' => '

The name of a computation.

', 'GenerateEmbedUrlForAnonymousUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GenerateEmbedUrlForRegisteredUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GetDashboardEmbedUrlResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'GetSessionEmbedUrlResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'Group$PrincipalId' => '

The principal ID of the group.

', 'GroupSearchFilter$Value' => '

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

', 'GroupsList$member' => NULL, 'GrowthRateComputation$Name' => '

The name of a computation.

', 'IAMPolicyAssignment$AssignmentId' => '

Assignment ID.

', 'IdentityMap$key' => NULL, 'IdentityTypeNotSupportedException$Message' => NULL, 'IdentityTypeNotSupportedException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InternalFailureException$Message' => NULL, 'InternalFailureException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidNextTokenException$Message' => NULL, 'InvalidNextTokenException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidParameterValueException$Message' => NULL, 'InvalidParameterValueException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'InvalidRequestException$Message' => NULL, 'InvalidRequestException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'LabelOptions$CustomLabel' => '

The text for the label.

', 'LimitExceededException$Message' => NULL, 'LimitExceededException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ListAnalysesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListAnalysesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListAnalysesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListAssetBundleExportJobsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleExportJobsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleImportJobsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListAssetBundleImportJobsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDashboardsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDashboardsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDataSetsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSetsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSetsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListDataSourcesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSourcesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListDataSourcesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListFolderMembersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFolderMembersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFolderMembersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListFoldersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFoldersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListFoldersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListGroupMembershipsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupMembershipsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupMembershipsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIAMPolicyAssignmentsForUserRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsForUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIAMPolicyAssignmentsForUserResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIAMPolicyAssignmentsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIdentityPropagationConfigsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIdentityPropagationConfigsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIdentityPropagationConfigsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListIngestionsRequest$DataSetId' => '

The ID of the dataset used in the ingestion.

', 'ListIngestionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIngestionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListIngestionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListNamespacesRequest$NextToken' => '

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

', 'ListNamespacesResponse$NextToken' => '

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

', 'ListNamespacesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListRefreshSchedulesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListRoleMembershipsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListRoleMembershipsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListRoleMembershipsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTagsForResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplateAliasesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateAliasesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplateAliasesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplateVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTemplatesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplatesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTemplatesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemeAliasesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeAliasesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemeAliasesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemeVersionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListThemesRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemesResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListThemesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicRefreshSchedulesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicReviewedAnswersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListTopicsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTopicsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListTopicsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListUserGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUserGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUserGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListUsersRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUsersResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'ListUsersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ListVPCConnectionsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListVPCConnectionsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'ListVPCConnectionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'LookbackWindow$ColumnName' => '

The name of the lookback window column.

', 'MaximumMinimumComputation$Name' => '

The name of a computation.

', 'MetricComparisonComputation$Name' => '

The name of a computation.

', 'NamespaceError$Message' => '

The message for the error.

', 'NamespaceInfoV2$CapacityRegion' => '

The namespace Amazon Web Services Region.

', 'NetworkInterface$AvailabilityZone' => '

The availability zone that the network interface resides in.

', 'NetworkInterface$ErrorMessage' => '

An error message.

', 'ParameterSelectableValueList$member' => NULL, 'PeriodOverPeriodComputation$Name' => '

The name of a computation.

', 'PeriodToDateComputation$Name' => '

The name of a computation.

', 'PivotTableFieldCollapseStateTarget$FieldId' => '

The field ID of the pivot table that the collapse state needs to be set to.

', 'PivotTotalOptions$CustomLabel' => '

The custom label string for the total cells.

', 'PreconditionNotMetException$Message' => NULL, 'PreconditionNotMetException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'PrincipalList$member' => NULL, 'ProjectedColumnList$member' => NULL, 'PutDataSetRefreshPropertiesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'QueueInfo$WaitingOnIngestion' => '

The ID of the queued ingestion.

', 'QueueInfo$QueuedIngestion' => '

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

', 'QuickSightUserNotFoundException$Message' => NULL, 'QuickSightUserNotFoundException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'RefreshFrequency$Timezone' => '

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

', 'RefreshFrequency$TimeOfTheDay' => '

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

', 'RefreshSchedule$ScheduleId' => '

An identifier for the refresh schedule.

', 'RegisterUserRequest$Email' => '

The email address of the user that you want to register.

', 'RegisterUserRequest$IamArn' => '

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

', 'RegisterUserRequest$ExternalLoginFederationProviderType' => '

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.

', 'RegisterUserRequest$CustomFederationProviderUrl' => '

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.

', 'RegisterUserRequest$ExternalLoginId' => '

The identity ID for a user in the external login provider.

', 'RegisterUserResponse$UserInvitationUrl' => '

The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

', 'RegisterUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'RegisteredCustomerManagedKey$KeyArn' => '

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

', 'ResourceExistsException$Message' => NULL, 'ResourceExistsException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'ResourceUnavailableException$Message' => NULL, 'ResourceUnavailableException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'RestoreAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'RowLevelPermissionTagRule$ColumnName' => '

The column name that a tag key is assigned to.

', 'SearchAnalysesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchAnalysesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchAnalysesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDashboardsRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchDashboardsResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchDashboardsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDataSetsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSetsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSetsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchDataSourcesRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSourcesResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchDataSourcesResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchFoldersRequest$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchFoldersResponse$NextToken' => '

The token for the next set of results, or null if there are no more results.

', 'SearchFoldersResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SearchGroupsRequest$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchGroupsResponse$NextToken' => '

A pagination token that can be used in a subsequent request.

', 'SearchGroupsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'SessionLifetimeInMinutesInvalidException$Message' => NULL, 'SessionLifetimeInMinutesInvalidException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'SignupResponse$userLoginName' => '

The user login name for your Amazon QuickSight account.

', 'SignupResponse$accountName' => '

The name of your Amazon QuickSight account.

', 'SignupResponse$directoryType' => '

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.

', 'SnapshotJobErrorInfo$ErrorMessage' => '

The error message.

', 'SnapshotJobErrorInfo$ErrorType' => '

The error type.

', 'SnapshotJobResultErrorInfo$ErrorMessage' => '

The error message.

', 'SnapshotJobResultErrorInfo$ErrorType' => '

The error type.

', 'StringList$member' => NULL, 'SubtotalOptions$CustomLabel' => '

The custom label string for the subtotal cells.

', 'SuccessfulKeyRegistrationEntry$KeyArn' => '

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

', 'TableFieldCustomTextContent$Value' => '

The string value of the custom text content for the table URL link content.

', 'TagResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'ThrottlingException$Message' => NULL, 'ThrottlingException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'TopBottomMoversComputation$Name' => '

The name of a computation.

', 'TopBottomRankedComputation$Name' => '

The name of a computation.

', 'TotalAggregationComputation$Name' => '

The name of a computation.

', 'TotalOptions$CustomLabel' => '

The custom label string for the total cells.

', 'UniqueValuesComputation$Name' => '

The name of a computation.

', 'UnsupportedPricingPlanException$Message' => NULL, 'UnsupportedPricingPlanException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'UnsupportedUserEditionException$Message' => NULL, 'UnsupportedUserEditionException$RequestId' => '

The Amazon Web Services request ID for this request.

', 'UntagResourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAccountCustomizationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAccountSettingsRequest$NotificationEmail' => '

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

', 'UpdateAccountSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAnalysisPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateAnalysisResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardLinksResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardPublishedVersionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDashboardResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSetPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSetResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSourcePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateDataSourceResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateFolderPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateFolderResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateGroupResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIAMPolicyAssignmentResponse$AssignmentId' => '

The ID of the assignment.

', 'UpdateIAMPolicyAssignmentResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIdentityPropagationConfigResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateIpRestrictionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdatePublicSharingSettingsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateRefreshScheduleResponse$ScheduleId' => '

The ID of the refresh schedule.

', 'UpdateRoleCustomPermissionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateSPICECapacityConfigurationResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplateAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplatePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTemplateResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemeAliasResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemePermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateThemeResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicPermissionsResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicRefreshScheduleRequest$DatasetId' => '

The ID of the dataset.

', 'UpdateTopicRefreshScheduleResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateTopicResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateUserRequest$Email' => '

The email address of the user that you want to update.

', 'UpdateUserRequest$ExternalLoginFederationProviderType' => '

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.

', 'UpdateUserRequest$CustomFederationProviderUrl' => '

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.

', 'UpdateUserRequest$ExternalLoginId' => '

The identity ID for a user in the external login provider.

', 'UpdateUserResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'UpdateVPCConnectionResponse$RequestId' => '

The Amazon Web Services request ID for this operation.

', 'User$Email' => '

The user\'s email address.

', 'User$PrincipalId' => '

The principal ID of the user.

', 'User$ExternalLoginFederationProviderType' => '

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

', 'User$ExternalLoginFederationProviderUrl' => '

The URL of the external login provider.

', 'User$ExternalLoginId' => '

The identity ID for the user in the external login provider.

', 'VPCConnection$VPCId' => '

The Amazon EC2 VPC ID associated with the VPC connection.

', 'VPCConnection$RoleArn' => '

The ARN of the IAM role associated with the VPC connection.

', 'VPCConnectionSummary$VPCId' => '

The Amazon EC2 VPC ID associated with the VPC connection.

', 'VPCConnectionSummary$RoleArn' => '

The ARN of the IAM role associated with the VPC connection.

', 'WaterfallChartOptions$TotalBarLabel' => '

This option determines the total bar label of a waterfall visual.

', ], ], 'StringDatasetParameter' => [ 'base' => '

A string parameter for a dataset.

', 'refs' => [ 'DatasetParameter$StringDatasetParameter' => '

A string parameter that is created in the dataset.

', ], ], 'StringDatasetParameterDefaultValue' => [ 'base' => '

The default value for the string parameter.

', 'refs' => [ 'StringDatasetParameterValueList$member' => NULL, ], ], 'StringDatasetParameterDefaultValues' => [ 'base' => '

The default values of a string parameter.

', 'refs' => [ 'StringDatasetParameter$DefaultValues' => '

A list of default values for a given string dataset parameter type. This structure only accepts static values.

', ], ], 'StringDatasetParameterValueList' => [ 'base' => NULL, 'refs' => [ 'NewDefaultValues$StringStaticValues' => '

A list of static default values for a given string parameter.

', 'StringDatasetParameterDefaultValues$StaticValues' => '

A list of static default values for a given string parameter.

', ], ], 'StringDefaultValueList' => [ 'base' => NULL, 'refs' => [ 'CustomParameterValues$StringValues' => '

A list of string-type parameter values.

', 'StringDefaultValues$StaticValues' => '

The static values of the DecimalDefaultValues.

', ], ], 'StringDefaultValues' => [ 'base' => '

The default values of the StringParameterDeclaration.

', 'refs' => [ 'StringParameterDeclaration$DefaultValues' => '

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

', ], ], 'StringFormatConfiguration' => [ 'base' => '

Formatting configuration for string fields.

', 'refs' => [ 'CategoricalDimensionField$FormatConfiguration' => '

The format configuration of the field.

', 'CategoricalMeasureField$FormatConfiguration' => '

The format configuration of the field.

', 'FormatConfiguration$StringFormatConfiguration' => '

Formatting configuration for string fields.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CellValueSynonym$Synonyms' => '

Other names or aliases for the cell value.

', 'CollectiveConstant$ValueList' => '

A list of values for the collective constant.

', 'ComparativeOrder$SpecifedOrder' => '

The list of columns to be used in the ordering.

', 'GenerateEmbedUrlForAnonymousUserRequest$AllowedDomains' => '

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.

', 'GenerateEmbedUrlForRegisteredUserRequest$AllowedDomains' => '

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.

', 'VPCConnection$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', 'VPCConnectionSummary$DnsResolvers' => '

A list of IP addresses of DNS resolver endpoints for the VPC connection.

', ], ], 'StringParameter' => [ 'base' => '

A string parameter.

', 'refs' => [ 'StringParameterList$member' => NULL, ], ], 'StringParameterDeclaration' => [ 'base' => '

A parameter declaration for the String data type.

', 'refs' => [ 'ParameterDeclaration$StringParameterDeclaration' => '

A parameter declaration for the String data type.

', ], ], 'StringParameterList' => [ 'base' => NULL, 'refs' => [ 'Parameters$StringParameters' => '

The parameters that have a data type of string.

', ], ], 'StringValueWhenUnsetConfiguration' => [ 'base' => '

The configuration that defines the default value of a String parameter when a value has not been set.

', 'refs' => [ 'StringParameterDeclaration$ValueWhenUnset' => '

The configuration that defines the default value of a String parameter when a value has not been set.

', ], ], 'StyledCellType' => [ 'base' => NULL, 'refs' => [ 'TableStyleTarget$CellType' => '

The cell type of the table style target.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'NetworkInterface$SubnetId' => '

The subnet ID associated with the network interface.

', 'SubnetIdList$member' => NULL, ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$SubnetIds' => '

A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.

', 'CreateVPCConnectionRequest$SubnetIds' => '

A list of subnet IDs for the VPC connection.

', 'UpdateVPCConnectionRequest$SubnetIds' => '

A list of subnet IDs for the VPC connection.

', ], ], 'SubtotalOptions' => [ 'base' => '

The subtotal options.

', 'refs' => [ 'PivotTableTotalOptions$RowSubtotalOptions' => '

The row subtotal options.

', 'PivotTableTotalOptions$ColumnSubtotalOptions' => '

The column subtotal options.

', ], ], 'SucceededTopicReviewedAnswer' => [ 'base' => '

The definition for a SucceededTopicReviewedAnswer.

', 'refs' => [ 'SucceededTopicReviewedAnswers$member' => NULL, ], ], 'SucceededTopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerResponse$SucceededAnswers' => '

The definition of Answers that are successfully created.

', 'BatchDeleteTopicReviewedAnswerResponse$SucceededAnswers' => '

The definition of Answers that are successfully deleted.

', ], ], 'SuccessfulKeyRegistrationEntries' => [ 'base' => NULL, 'refs' => [ 'UpdateKeyRegistrationResponse$SuccessfulKeyRegistration' => '

A list of all customer managed key registrations that were successfully updated.

', ], ], 'SuccessfulKeyRegistrationEntry' => [ 'base' => '

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

', 'refs' => [ 'SuccessfulKeyRegistrationEntries$member' => NULL, ], ], 'Suffix' => [ 'base' => NULL, 'refs' => [ 'CurrencyDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the currency format.

', 'NumberDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the number format.

', 'PercentageDisplayFormatConfiguration$Suffix' => '

Determines the suffix value of the percentage format.

', ], ], 'Synonyms' => [ 'base' => NULL, 'refs' => [ 'TopicCalculatedField$CalculatedFieldSynonyms' => '

The other names or aliases for the calculated field.

', 'TopicColumn$ColumnSynonyms' => '

The other names or aliases for the column.

', 'TopicFilter$FilterSynonyms' => '

The other names or aliases for the filter.

', 'TopicNamedEntity$EntitySynonyms' => '

The other names or aliases for the named entity.

', ], ], 'TableAggregatedFieldWells' => [ 'base' => '

The aggregated field well for the table.

', 'refs' => [ 'TableFieldWells$TableAggregatedFieldWells' => '

The aggregated field well for the table.

', ], ], 'TableBorderOptions' => [ 'base' => '

The border options for a table border.

', 'refs' => [ 'GlobalTableBorderOptions$UniformBorder' => '

Determines the options for uniform border.

', 'TableSideBorderOptions$InnerVertical' => '

The table border options of the inner vertical border.

', 'TableSideBorderOptions$InnerHorizontal' => '

The table border options of the inner horizontal border.

', 'TableSideBorderOptions$Left' => '

The table border options of the left border.

', 'TableSideBorderOptions$Right' => '

The table border options of the right border.

', 'TableSideBorderOptions$Top' => '

The table border options of the top border.

', 'TableSideBorderOptions$Bottom' => '

The table border options of the bottom border.

', ], ], 'TableBorderStyle' => [ 'base' => NULL, 'refs' => [ 'TableBorderOptions$Style' => '

The style (none, solid) of a table border.

', ], ], 'TableBorderThickness' => [ 'base' => NULL, 'refs' => [ 'TableBorderOptions$Thickness' => '

The thickness of a table border.

', ], ], 'TableCellConditionalFormatting' => [ 'base' => '

The cell conditional formatting option for a table.

', 'refs' => [ 'TableConditionalFormattingOption$Cell' => '

The cell conditional formatting option for a table.

', ], ], 'TableCellImageScalingConfiguration' => [ 'base' => NULL, 'refs' => [ 'TableCellImageSizingConfiguration$TableCellImageScalingConfiguration' => '

The cell scaling configuration of the sizing options for the table image configuration.

', ], ], 'TableCellImageSizingConfiguration' => [ 'base' => '

The sizing options for the table image configuration.

', 'refs' => [ 'TableFieldImageConfiguration$SizingOptions' => '

The sizing options for the table image configuration.

', ], ], 'TableCellStyle' => [ 'base' => '

The table cell style for a cell in pivot table or table visual.

', 'refs' => [ 'PivotTableOptions$ColumnHeaderStyle' => '

The table cell style of the column header.

', 'PivotTableOptions$RowHeaderStyle' => '

The table cell style of the row headers.

', 'PivotTableOptions$CellStyle' => '

The table cell style of cells.

', 'PivotTableOptions$RowFieldNamesStyle' => '

The table cell style of row field names.

', 'PivotTotalOptions$TotalCellStyle' => '

The cell styling options for the total cells.

', 'PivotTotalOptions$ValueCellStyle' => '

The cell styling options for the totals of value cells.

', 'PivotTotalOptions$MetricHeaderCellStyle' => '

The cell styling options for the total of header cells.

', 'SubtotalOptions$TotalCellStyle' => '

The cell styling options for the subtotal cells.

', 'SubtotalOptions$ValueCellStyle' => '

The cell styling options for the subtotals of value cells.

', 'SubtotalOptions$MetricHeaderCellStyle' => '

The cell styling options for the subtotals of header cells.

', 'TableOptions$HeaderStyle' => '

The table cell style of a table header.

', 'TableOptions$CellStyle' => '

The table cell style of table cells.

', 'TotalOptions$TotalCellStyle' => '

Cell styling options for the total cells.

', ], ], 'TableConditionalFormatting' => [ 'base' => '

The conditional formatting for a PivotTableVisual.

', 'refs' => [ 'TableVisual$ConditionalFormatting' => '

The conditional formatting for a PivotTableVisual.

', ], ], 'TableConditionalFormattingOption' => [ 'base' => '

Conditional formatting options for a PivotTableVisual.

', 'refs' => [ 'TableConditionalFormattingOptionList$member' => NULL, ], ], 'TableConditionalFormattingOptionList' => [ 'base' => NULL, 'refs' => [ 'TableConditionalFormatting$ConditionalFormattingOptions' => '

Conditional formatting options for a PivotTableVisual.

', ], ], 'TableConfiguration' => [ 'base' => '

The configuration for a TableVisual.

', 'refs' => [ 'TableVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'TableFieldCustomIconContent' => [ 'base' => '

The custom icon content for the table link content configuration.

', 'refs' => [ 'TableFieldLinkContentConfiguration$CustomIconContent' => '

The custom icon content for the table link content configuration.

', ], ], 'TableFieldCustomTextContent' => [ 'base' => '

The custom text content (value, font configuration) for the table link content configuration.

', 'refs' => [ 'TableFieldLinkContentConfiguration$CustomTextContent' => '

The custom text content (value, font configuration) for the table link content configuration.

', ], ], 'TableFieldHeight' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$Height' => '

The height color for the table cells.

', ], ], 'TableFieldIconSetType' => [ 'base' => NULL, 'refs' => [ 'TableFieldCustomIconContent$Icon' => '

The icon set type (link) of the custom icon content for table URL link content.

', ], ], 'TableFieldImageConfiguration' => [ 'base' => '

The image configuration of a table field URL.

', 'refs' => [ 'TableFieldURLConfiguration$ImageConfiguration' => '

The image configuration of a table field URL.

', ], ], 'TableFieldLinkConfiguration' => [ 'base' => '

The link configuration of a table field URL.

', 'refs' => [ 'TableFieldURLConfiguration$LinkConfiguration' => '

The link configuration of a table field URL.

', ], ], 'TableFieldLinkContentConfiguration' => [ 'base' => '

The URL content (text, icon) for the table link configuration.

', 'refs' => [ 'TableFieldLinkConfiguration$Content' => '

The URL content (text, icon) for the table link configuration.

', ], ], 'TableFieldOption' => [ 'base' => '

The options for a table field.

', 'refs' => [ 'TableFieldOptionList$member' => NULL, ], ], 'TableFieldOptionList' => [ 'base' => NULL, 'refs' => [ 'TableFieldOptions$SelectedFieldOptions' => '

The field options to be configured to a table.

', ], ], 'TableFieldOptions' => [ 'base' => '

The field options of a table visual.

', 'refs' => [ 'TableConfiguration$FieldOptions' => '

The field options for a table visual.

', ], ], 'TableFieldOrderList' => [ 'base' => '

A list of table field IDs.

', 'refs' => [ 'TablePinnedFieldOptions$PinnedLeftFields' => '

A list of columns to be pinned to the left of a table visual.

', ], ], 'TableFieldURLConfiguration' => [ 'base' => '

The URL configuration for a table field.

', 'refs' => [ 'TableFieldOption$URLStyling' => '

The URL configuration for a table field.

', ], ], 'TableFieldWells' => [ 'base' => '

The field wells for a table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TableConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'TableInlineVisualization' => [ 'base' => '

The inline visualization of a specific type to display within a chart.

', 'refs' => [ 'TableInlineVisualizationList$member' => NULL, ], ], 'TableInlineVisualizationList' => [ 'base' => NULL, 'refs' => [ 'TableConfiguration$TableInlineVisualizations' => '

A collection of inline visualizations to display within a chart.

', ], ], 'TableOptions' => [ 'base' => '

The table options for a table visual.

', 'refs' => [ 'TableConfiguration$TableOptions' => '

The table options for a table visual.

', ], ], 'TableOrientation' => [ 'base' => NULL, 'refs' => [ 'TableOptions$Orientation' => '

The orientation (vertical, horizontal) for a table.

', ], ], 'TablePaginatedReportOptions' => [ 'base' => '

The paginated report options for a table visual.

', 'refs' => [ 'TableConfiguration$PaginatedReportOptions' => '

The paginated report options for a table visual.

', ], ], 'TablePinnedFieldOptions' => [ 'base' => '

The settings for the pinned columns of a table visual.

', 'refs' => [ 'TableFieldOptions$PinnedFieldOptions' => '

The settings for the pinned columns of a table visual.

', ], ], 'TableRowConditionalFormatting' => [ 'base' => '

The conditional formatting of a table row.

', 'refs' => [ 'TableConditionalFormattingOption$Row' => '

The row conditional formatting option for a table.

', ], ], 'TableSideBorderOptions' => [ 'base' => '

The side border options for a table.

', 'refs' => [ 'GlobalTableBorderOptions$SideSpecificBorder' => '

Determines the options for side specific border.

', ], ], 'TableSortConfiguration' => [ 'base' => '

The sort configuration for a TableVisual.

', 'refs' => [ 'TableConfiguration$SortConfiguration' => '

The sort configuration for a TableVisual.

', ], ], 'TableStyleTarget' => [ 'base' => '

The table style target.

', 'refs' => [ 'TableStyleTargetList$member' => NULL, ], ], 'TableStyleTargetList' => [ 'base' => NULL, 'refs' => [ 'SubtotalOptions$StyleTargets' => '

The style targets options for subtotals.

', ], ], 'TableTotalsPlacement' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$Placement' => '

The placement (start, end) for the total cells.

', 'TotalOptions$Placement' => '

The placement (start, end) for the total cells.

', ], ], 'TableTotalsScrollStatus' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$ScrollStatus' => '

The scroll status (pinned, scrolled) for the total cells.

', 'TotalOptions$ScrollStatus' => '

The scroll status (pinned, scrolled) for the total cells.

', ], ], 'TableUnaggregatedFieldWells' => [ 'base' => '

The unaggregated field well for the table.

', 'refs' => [ 'TableFieldWells$TableUnaggregatedFieldWells' => '

The unaggregated field well for the table.

', ], ], 'TableVisual' => [ 'base' => '

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$TableVisual' => '

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

', ], ], 'Tag' => [ 'base' => '

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagColumnOperation' => [ 'base' => '

A transform operation that tags a column with additional information.

', 'refs' => [ 'TransformOperation$TagColumnOperation' => '

An operation that tags a column with additional information.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

Tag key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobAnalysisOverrideTags$Tags' => '

A list of tags for the analyses that you want to apply overrides to.

', 'AssetBundleImportJobDashboardOverrideTags$Tags' => '

A list of tags for the dashboards that you want to apply overrides to.

', 'AssetBundleImportJobDataSetOverrideTags$Tags' => '

A list of tags for the datasets that you want to apply overrides to.

', 'AssetBundleImportJobDataSourceOverrideTags$Tags' => '

A list of tags for the data source that you want to apply overrides to.

', 'AssetBundleImportJobThemeOverrideTags$Tags' => '

A list of tags for the themes that you want to apply overrides to.

', 'AssetBundleImportJobVPCConnectionOverrideTags$Tags' => '

A list of tags for the VPC connections that you want to apply overrides to.

', 'CreateAccountCustomizationRequest$Tags' => '

A list of the tags that you want to attach to this resource.

', 'CreateAnalysisRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

', 'CreateDashboardRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

', 'CreateDataSetRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

', 'CreateDataSourceRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

', 'CreateFolderRequest$Tags' => '

Tags for the folder.

', 'CreateNamespaceRequest$Tags' => '

The tags that you want to associate with the namespace that you\'re creating.

', 'CreateTemplateRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', 'CreateThemeRequest$Tags' => '

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

', 'CreateTopicRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.

', 'CreateVPCConnectionRequest$Tags' => '

A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

', 'ListTagsForResourceResponse$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', 'RegisterUserRequest$Tags' => '

The tags to associate with the user.

', 'TagResourceRequest$Tags' => '

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Tag value.

', ], ], 'TargetVisualList' => [ 'base' => NULL, 'refs' => [ 'SameSheetTargetVisualConfiguration$TargetVisuals' => '

A list of the target visual IDs that are located in the same sheet of the analysis.

', ], ], 'TargetVisualOptions' => [ 'base' => NULL, 'refs' => [ 'SameSheetTargetVisualConfiguration$TargetVisualOptions' => '

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

', ], ], 'Template' => [ 'base' => '

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.

', 'refs' => [ 'DescribeTemplateResponse$Template' => '

The template structure for the object you want to describe.

', ], ], 'TemplateAlias' => [ 'base' => '

The template alias.

', 'refs' => [ 'CreateTemplateAliasResponse$TemplateAlias' => '

Information about the template alias.

', 'DescribeTemplateAliasResponse$TemplateAlias' => '

Information about the template alias.

', 'TemplateAliasList$member' => NULL, 'UpdateTemplateAliasResponse$TemplateAlias' => '

The template alias.

', ], ], 'TemplateAliasList' => [ 'base' => NULL, 'refs' => [ 'ListTemplateAliasesResponse$TemplateAliasList' => '

A structure containing the list of the template\'s aliases.

', ], ], 'TemplateError' => [ 'base' => '

List of errors that occurred when the template version creation failed.

', 'refs' => [ 'TemplateErrorList$member' => NULL, ], ], 'TemplateErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeTemplateDefinitionResponse$Errors' => '

Errors associated with the template version.

', 'TemplateVersion$Errors' => '

Errors associated with this template version.

', ], ], 'TemplateErrorType' => [ 'base' => NULL, 'refs' => [ 'TemplateError$Type' => '

Type of error.

', ], ], 'TemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateRequest$Name' => '

A display name for the template.

', 'DescribeTemplateDefinitionResponse$Name' => '

The descriptive name of the template.

', 'Template$Name' => '

The display name of the template.

', 'TemplateSummary$Name' => '

A display name for the template.

', 'UpdateTemplateRequest$Name' => '

The name for the template.

', ], ], 'TemplateSourceAnalysis' => [ 'base' => '

The source analysis of the template.

', 'refs' => [ 'TemplateSourceEntity$SourceAnalysis' => '

The source analysis, if it is based on an analysis.

', ], ], 'TemplateSourceEntity' => [ 'base' => '

The source entity of the template.

', 'refs' => [ 'CreateTemplateRequest$SourceEntity' => '

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.

', 'UpdateTemplateRequest$SourceEntity' => '

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.

', ], ], 'TemplateSourceTemplate' => [ 'base' => '

The source template of the template.

', 'refs' => [ 'TemplateSourceEntity$SourceTemplate' => '

The source template, if it is based on an template.

', ], ], 'TemplateSummary' => [ 'base' => '

The template summary.

', 'refs' => [ 'TemplateSummaryList$member' => NULL, ], ], 'TemplateSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTemplatesResponse$TemplateSummaryList' => '

A structure containing information about the templates in the list.

', ], ], 'TemplateVersion' => [ 'base' => '

A version of a template.

', 'refs' => [ 'Template$Version' => '

A structure describing the versions of the template.

', ], ], 'TemplateVersionDefinition' => [ 'base' => '

The detailed definition of a template.

', 'refs' => [ 'CreateTemplateRequest$Definition' => '

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

', 'DescribeTemplateDefinitionResponse$Definition' => '

The definition of the template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', 'UpdateTemplateRequest$Definition' => '

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

', ], ], 'TemplateVersionSummary' => [ 'base' => '

The template version.

', 'refs' => [ 'TemplateVersionSummaryList$member' => NULL, ], ], 'TemplateVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTemplateVersionsResponse$TemplateVersionSummaryList' => '

A structure containing a list of all the versions of the specified template.

', ], ], 'TeradataParameters' => [ 'base' => '

The parameters for Teradata.

', 'refs' => [ 'DataSourceParameters$TeradataParameters' => '

The parameters for Teradata.

', ], ], 'TextAreaControlDelimiter' => [ 'base' => NULL, 'refs' => [ 'DefaultTextAreaControlOptions$Delimiter' => '

The delimiter that is used to separate the lines in text.

', 'FilterTextAreaControl$Delimiter' => '

The delimiter that is used to separate the lines in text.

', 'ParameterTextAreaControl$Delimiter' => '

The delimiter that is used to separate the lines in text.

', ], ], 'TextAreaControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultTextAreaControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterTextAreaControl$DisplayOptions' => '

The display options of a control.

', 'ParameterTextAreaControl$DisplayOptions' => '

The display options of a control.

', ], ], 'TextConditionalFormat' => [ 'base' => '

The conditional formatting for the text.

', 'refs' => [ 'PivotTableCellConditionalFormatting$TextFormat' => '

The text format of the cell for conditional formatting.

', 'TableCellConditionalFormatting$TextFormat' => '

The text format of the cell for conditional formatting.

', ], ], 'TextControlPlaceholderOptions' => [ 'base' => '

The configuration of the placeholder options in a text control.

', 'refs' => [ 'TextAreaControlDisplayOptions$PlaceholderOptions' => '

The configuration of the placeholder options in a text area control.

', 'TextFieldControlDisplayOptions$PlaceholderOptions' => '

The configuration of the placeholder options in a text field control.

', ], ], 'TextFieldControlDisplayOptions' => [ 'base' => '

The display options of a control.

', 'refs' => [ 'DefaultTextFieldControlOptions$DisplayOptions' => '

The display options of a control.

', 'FilterTextFieldControl$DisplayOptions' => '

The display options of a control.

', 'ParameterTextFieldControl$DisplayOptions' => '

The display options of a control.

', ], ], 'TextQualifier' => [ 'base' => NULL, 'refs' => [ 'UploadSettings$TextQualifier' => '

Text qualifier.

', ], ], 'TextWrap' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$TextWrap' => '

The text wrap (none, wrap) for the table cells.

', ], ], 'Theme' => [ 'base' => '

Summary information about a theme.

', 'refs' => [ 'DescribeThemeResponse$Theme' => '

The information about the theme that you are describing.

', ], ], 'ThemeAlias' => [ 'base' => '

An alias for a theme.

', 'refs' => [ 'CreateThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', 'DescribeThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', 'ThemeAliasList$member' => NULL, 'UpdateThemeAliasResponse$ThemeAlias' => '

Information about the theme alias.

', ], ], 'ThemeAliasList' => [ 'base' => NULL, 'refs' => [ 'ListThemeAliasesResponse$ThemeAliasList' => '

A structure containing the list of the theme\'s aliases.

', ], ], 'ThemeConfiguration' => [ 'base' => '

The theme configuration. This configuration contains all of the display properties for a theme.

', 'refs' => [ 'CreateThemeRequest$Configuration' => '

The theme configuration, which contains the theme display properties.

', 'ThemeVersion$Configuration' => '

The theme configuration, which contains all the theme display properties.

', 'UpdateThemeRequest$Configuration' => '

The theme configuration, which contains the theme display properties.

', ], ], 'ThemeError' => [ 'base' => '

Theme error.

', 'refs' => [ 'ThemeErrorList$member' => NULL, ], ], 'ThemeErrorList' => [ 'base' => NULL, 'refs' => [ 'ThemeVersion$Errors' => '

Errors associated with the theme.

', ], ], 'ThemeErrorType' => [ 'base' => NULL, 'refs' => [ 'ThemeError$Type' => '

The type of error.

', ], ], 'ThemeName' => [ 'base' => NULL, 'refs' => [ 'CreateThemeRequest$Name' => '

A display name for the theme.

', 'Theme$Name' => '

The name that the user gives to the theme.

', 'ThemeSummary$Name' => '

the display name for the theme.

', 'UpdateThemeRequest$Name' => '

The name for the theme.

', ], ], 'ThemeSummary' => [ 'base' => '

The theme summary.

', 'refs' => [ 'ThemeSummaryList$member' => NULL, ], ], 'ThemeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListThemesResponse$ThemeSummaryList' => '

Information about the themes in the list.

', ], ], 'ThemeType' => [ 'base' => NULL, 'refs' => [ 'ListThemesRequest$Type' => '

The type of themes that you want to list. Valid options include the following:

', 'Theme$Type' => '

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

', ], ], 'ThemeVersion' => [ 'base' => '

A version of a theme.

', 'refs' => [ 'Theme$Version' => NULL, ], ], 'ThemeVersionSummary' => [ 'base' => '

The theme version.

', 'refs' => [ 'ThemeVersionSummaryList$member' => NULL, ], ], 'ThemeVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListThemeVersionsResponse$ThemeVersionSummaryList' => '

A structure containing a list of all the versions of the specified theme.

', ], ], 'ThousandSeparatorOptions' => [ 'base' => '

The options that determine the thousands separator configuration.

', 'refs' => [ 'NumericSeparatorConfiguration$ThousandsSeparator' => '

The options that determine the thousands separator configuration.

', ], ], 'ThrottlingException' => [ 'base' => '

Access is throttled.

', 'refs' => [], ], 'TileLayoutStyle' => [ 'base' => '

The display options for the layout of tiles on a sheet.

', 'refs' => [ 'SheetStyle$TileLayout' => '

The layout options for tiles.

', ], ], 'TileStyle' => [ 'base' => '

Display options related to tiles on a sheet.

', 'refs' => [ 'SheetStyle$Tile' => '

The display options for tiles.

', ], ], 'TimeBasedForecastProperties' => [ 'base' => '

The forecast properties setup of a forecast in the line chart.

', 'refs' => [ 'ForecastConfiguration$ForecastProperties' => '

The forecast properties setup of a forecast in the line chart.

', ], ], 'TimeEqualityFilter' => [ 'base' => '

A TimeEqualityFilter filters values that are equal to a given value.

', 'refs' => [ 'Filter$TimeEqualityFilter' => '

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

', ], ], 'TimeGranularity' => [ 'base' => NULL, 'refs' => [ 'AggregationPartitionBy$TimeGranularity' => '

The TimeGranularity for an AggregationPartitionBy.

', 'Anchor$TimeGranularity' => '

The TimeGranularity of the Anchor.

', 'DataPathColor$TimeGranularity' => '

The time granularity of the field that the color needs to be applied to.

', 'DateDimensionField$DateGranularity' => '

The date granularity of the DateDimensionField. Choose one of the following options:

', 'DateTimeDatasetParameter$TimeGranularity' => '

The time granularity of the date time parameter.

', 'DateTimeParameterDeclaration$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'ExcludePeriodConfiguration$Granularity' => '

The granularity or unit (day, month, year) of the exclude period.

', 'PeriodToDateComputation$PeriodTimeGranularity' => '

The time granularity setup of period to date computation. Choose from the following options:

', 'RelativeDatesFilter$MinimumGranularity' => '

The minimum granularity (period granularity) of the relative dates filter.

', 'RelativeDatesFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeEqualityFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeRangeDrillDownFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TimeRangeFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopBottomFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicIRFilterOption$TimeGranularity' => '

The time granularity for the TopicIRFilterOption.

', ], ], 'TimeRangeDrillDownFilter' => [ 'base' => '

The time range drill down filter.

', 'refs' => [ 'DrillDownFilter$TimeRangeFilter' => '

The time range drill down filter. This filter is used for date time columns.

', ], ], 'TimeRangeFilter' => [ 'base' => '

A TimeRangeFilter filters values that are between two specified values.

', 'refs' => [ 'Filter$TimeRangeFilter' => '

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

', ], ], 'TimeRangeFilterValue' => [ 'base' => '

The value of a time range filter.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TimeRangeFilter$RangeMinimumValue' => '

The minimum value for the filter value range.

', 'TimeRangeFilter$RangeMaximumValue' => '

The maximum value for the filter value range.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Analysis$CreatedTime' => '

The time that the analysis was created.

', 'Analysis$LastUpdatedTime' => '

The time that the analysis was last updated.

', 'AnalysisSummary$CreatedTime' => '

The time that the analysis was created.

', 'AnalysisSummary$LastUpdatedTime' => '

The time that the analysis was last updated.

', 'AssetBundleExportJobSummary$CreatedTime' => '

The time that the export job was created.

', 'AssetBundleImportJobRefreshScheduleOverrideParameters$StartAfterDateTime' => '

An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.

', 'AssetBundleImportJobSummary$CreatedTime' => '

The time that the import job was created.

', 'Dashboard$CreatedTime' => '

The time that this dashboard was created.

', 'Dashboard$LastPublishedTime' => '

The last time that this dashboard was published.

', 'Dashboard$LastUpdatedTime' => '

The last time that this dashboard was updated.

', 'DashboardSummary$CreatedTime' => '

The time that this dashboard was created.

', 'DashboardSummary$LastUpdatedTime' => '

The last time that this dashboard was updated.

', 'DashboardSummary$LastPublishedTime' => '

The last time that this dashboard was published.

', 'DashboardVersion$CreatedTime' => '

The time that this dashboard version was created.

', 'DashboardVersionSummary$CreatedTime' => '

The time that this dashboard version was created.

', 'DataSet$CreatedTime' => '

The time that this dataset was created.

', 'DataSet$LastUpdatedTime' => '

The last time that this dataset was updated.

', 'DataSetSummary$CreatedTime' => '

The time that this dataset was created.

', 'DataSetSummary$LastUpdatedTime' => '

The last time that this dataset was updated.

', 'DataSource$CreatedTime' => '

The time that this data source was created.

', 'DataSource$LastUpdatedTime' => '

The last time that this data source was updated.

', 'DataSourceSummary$CreatedTime' => '

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

', 'DataSourceSummary$LastUpdatedTime' => '

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

', 'DeleteAnalysisResponse$DeletionTime' => '

The date and time that the analysis is scheduled to be deleted.

', 'DescribeAssetBundleExportJobResponse$CreatedTime' => '

The time that the export job was created.

', 'DescribeAssetBundleImportJobResponse$CreatedTime' => '

The time that the import job was created.

', 'DescribeDashboardSnapshotJobResponse$CreatedTime' => '

The time that the snapshot job was created.

', 'DescribeDashboardSnapshotJobResponse$LastUpdatedTime' => '

The time that the snapshot job status was last updated.

', 'DescribeDashboardSnapshotJobResultResponse$CreatedTime' => '

The time that a snapshot job was created.

', 'DescribeDashboardSnapshotJobResultResponse$LastUpdatedTime' => '

The time that a snapshot job status was last updated.

', 'Folder$CreatedTime' => '

The time that the folder was created.

', 'Folder$LastUpdatedTime' => '

The time that the folder was last updated.

', 'FolderSummary$CreatedTime' => '

The time that the folder was created.

', 'FolderSummary$LastUpdatedTime' => '

The time that the folder was last updated.

', 'Ingestion$CreatedTime' => '

The time that this ingestion started.

', 'RefreshSchedule$StartAfterDateTime' => '

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

', 'Template$LastUpdatedTime' => '

Time when this was last updated.

', 'Template$CreatedTime' => '

Time when this was created.

', 'TemplateSummary$CreatedTime' => '

The last time that this template was created.

', 'TemplateSummary$LastUpdatedTime' => '

The last time that this template was updated.

', 'TemplateVersion$CreatedTime' => '

The time that this template version was created.

', 'TemplateVersionSummary$CreatedTime' => '

The time that this template version was created.

', 'Theme$CreatedTime' => '

The date and time that the theme was created.

', 'Theme$LastUpdatedTime' => '

The date and time that the theme was last updated.

', 'ThemeSummary$CreatedTime' => '

The date and time that this theme was created.

', 'ThemeSummary$LastUpdatedTime' => '

The last date and time that this theme was updated.

', 'ThemeVersion$CreatedTime' => '

The date and time that this theme version was created.

', 'ThemeVersionSummary$CreatedTime' => '

The date and time that this theme version was created.

', 'TimeEqualityFilter$Value' => '

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName.

', 'TimeRangeDrillDownFilter$RangeMinimum' => '

The minimum value for the filter value range.

', 'TimeRangeDrillDownFilter$RangeMaximum' => '

The maximum value for the filter value range.

', 'TimeRangeFilterValue$StaticValue' => '

The static input value.

', 'TopicRefreshSchedule$StartingAt' => '

The starting date and time for the refresh schedule.

', 'VPCConnection$CreatedTime' => '

The time that the VPC connection was created.

', 'VPCConnection$LastUpdatedTime' => '

The time that the VPC connection was last updated.

', 'VPCConnectionSummary$CreatedTime' => '

The time that the VPC connection was created.

', 'VPCConnectionSummary$LastUpdatedTime' => '

The time that the VPC connection was last updated.

', 'WhatIfPointScenario$Date' => '

The date that you need the forecast results for.

', 'WhatIfRangeScenario$StartDate' => '

The start date in the date range that you need the forecast results for.

', 'WhatIfRangeScenario$EndDate' => '

The end date in the date range that you need the forecast results for.

', ], ], 'TooltipItem' => [ 'base' => '

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TooltipItemList$member' => NULL, ], ], 'TooltipItemList' => [ 'base' => NULL, 'refs' => [ 'FieldBasedTooltip$TooltipFields' => '

The fields configuration in the tooltip.

', ], ], 'TooltipOptions' => [ 'base' => '

The display options for the visual tooltip.

', 'refs' => [ 'BarChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'BoxPlotChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'ComboChartConfiguration$Tooltip' => '

The legend display setup of the visual.

', 'FilledMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'FunnelChartConfiguration$Tooltip' => '

The tooltip configuration of a FunnelChartVisual.

', 'GaugeChartConfiguration$TooltipOptions' => '

The tooltip configuration of a GaugeChartVisual.

', 'GeospatialMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'HeatMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'HistogramConfiguration$Tooltip' => '

The tooltip configuration of a histogram.

', 'LineChartConfiguration$Tooltip' => '

The tooltip configuration of a line chart.

', 'PieChartConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', 'ScatterPlotConfiguration$Tooltip' => '

The legend display setup of the visual.

', 'TreeMapConfiguration$Tooltip' => '

The tooltip display setup of the visual.

', ], ], 'TooltipTarget' => [ 'base' => NULL, 'refs' => [ 'ColumnTooltipItem$TooltipTarget' => '

Determines the target of the column tooltip item in a combo chart visual.

', 'FieldTooltipItem$TooltipTarget' => '

Determines the target of the field tooltip item in a combo chart visual.

', ], ], 'TooltipTitleType' => [ 'base' => NULL, 'refs' => [ 'FieldBasedTooltip$TooltipTitleType' => '

The type for the >tooltip title. Choose one of the following options:

', ], ], 'TopBottomComputationType' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$Type' => '

The computation type. Choose from the following options:

', 'TopBottomRankedComputation$Type' => '

The computation type. Choose one of the following options:

', ], ], 'TopBottomFilter' => [ 'base' => '

A TopBottomFilter filters values that are at the top or the bottom.

', 'refs' => [ 'Filter$TopBottomFilter' => '

A TopBottomFilter filters data to the top or bottom values for a given column.

', ], ], 'TopBottomMoversComputation' => [ 'base' => '

The top movers and bottom movers computation setup.

', 'refs' => [ 'Computation$TopBottomMovers' => '

The top movers and bottom movers computation configuration.

', ], ], 'TopBottomMoversComputationMoverSize' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$MoverSize' => '

The mover size setup of the top and bottom movers computation.

', ], ], 'TopBottomRankedComputation' => [ 'base' => '

The top ranked and bottom ranked computation configuration.

', 'refs' => [ 'Computation$TopBottomRanked' => '

The top ranked and bottom ranked computation configuration.

', ], ], 'TopBottomRankedComputationResultSize' => [ 'base' => NULL, 'refs' => [ 'TopBottomRankedComputation$ResultSize' => '

The result size of a top and bottom ranked computation.

', ], ], 'TopBottomSortOrder' => [ 'base' => NULL, 'refs' => [ 'TopBottomMoversComputation$SortOrder' => '

The sort order setup of the top and bottom movers computation.

', ], ], 'TopicCalculatedField' => [ 'base' => '

A structure that represents a calculated field.

', 'refs' => [ 'TopicCalculatedFields$member' => NULL, ], ], 'TopicCalculatedFields' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$CalculatedFields' => '

The list of calculated field definitions.

', ], ], 'TopicCategoryFilter' => [ 'base' => '

A structure that represents a category filter.

', 'refs' => [ 'TopicFilter$CategoryFilter' => '

The category filter that is associated with this filter.

', ], ], 'TopicCategoryFilterConstant' => [ 'base' => '

A constant used in a category filter.

', 'refs' => [ 'TopicCategoryFilter$Constant' => '

The constant used in a category filter.

', ], ], 'TopicColumn' => [ 'base' => '

Represents a column in a dataset.

', 'refs' => [ 'TopicColumns$member' => NULL, ], ], 'TopicColumns' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$Columns' => '

The list of column definitions.

', ], ], 'TopicConstantValue' => [ 'base' => '

The definition for a TopicConstantValue.

', 'refs' => [ 'TopicIRFilterOption$Constant' => '

The constant for the TopicIRFilterOption.

', 'TopicIRFilterOption$Range' => '

The range for the TopicIRFilterOption.

', 'TopicIRFilterOption$LastNextOffset' => '

The last next offset for the TopicIRFilterOption.

', 'TopicIRFilterOption$TopBottomLimit' => '

The TopBottomLimit for the TopicIRFilterOption.

', ], ], 'TopicDateRangeFilter' => [ 'base' => '

A filter used to restrict data based on a range of dates or times.

', 'refs' => [ 'TopicFilter$DateRangeFilter' => '

The date range filter.

', ], ], 'TopicDetails' => [ 'base' => '

A structure that describes the details of a topic, such as its name, description, and associated data sets.

', 'refs' => [ 'CreateTopicRequest$Topic' => '

The definition of a topic to create.

', 'DescribeTopicResponse$Topic' => '

The definition of a topic.

', 'UpdateTopicRequest$Topic' => '

The definition of the topic that you want to update.

', ], ], 'TopicFilter' => [ 'base' => '

A structure that represents a filter used to select items for a topic.

', 'refs' => [ 'TopicFilters$member' => NULL, ], ], 'TopicFilters' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$Filters' => '

The list of filter definitions.

', ], ], 'TopicIR' => [ 'base' => '

The definition for a TopicIR.

', 'refs' => [ 'CreateTopicReviewedAnswer$Mir' => '

The Mir for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$Mir' => '

The mir for the TopicReviewedAnswer.

', 'TopicVisual$Ir' => '

The ir for the TopicVisual.

', ], ], 'TopicIRComparisonMethod' => [ 'base' => '

The definition of a TopicIRComparisonMethod.

', 'refs' => [ 'TopicIRMetric$ComparisonMethod' => '

The comparison method for the TopicIRMetric.

', ], ], 'TopicIRContributionAnalysis' => [ 'base' => '

The definition for a TopicIRContributionAnalysis.

', 'refs' => [ 'TopicIR$ContributionAnalysis' => '

The contribution analysis for the TopicIR.

', ], ], 'TopicIRFilterEntry' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterList$member' => NULL, ], ], 'TopicIRFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$Function' => '

The function for the TopicIRFilterOption.

', ], ], 'TopicIRFilterList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$Filters' => '

The filters for the TopicIR.

', ], ], 'TopicIRFilterOption' => [ 'base' => '

The definition for a TopicIRFilterOption.

', 'refs' => [ 'ContributionAnalysisTimeRanges$StartRange' => '

The start range for the ContributionAnalysisTimeRanges.

', 'ContributionAnalysisTimeRanges$EndRange' => '

The end range for the ContributionAnalysisTimeRanges.

', 'TopicIRFilterEntry$member' => NULL, ], ], 'TopicIRFilterType' => [ 'base' => NULL, 'refs' => [ 'TopicIRFilterOption$FilterType' => '

The filter type for the TopicIRFilterOption.

', ], ], 'TopicIRGroupBy' => [ 'base' => '

The definition for a TopicIRGroupBy.

', 'refs' => [ 'TopicIRGroupByList$member' => NULL, ], ], 'TopicIRGroupByList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$GroupByList' => '

The GroupBy list for the TopicIR.

', ], ], 'TopicIRMetric' => [ 'base' => '

The definition for a TopicIRMetric.

', 'refs' => [ 'TopicIRMetricList$member' => NULL, ], ], 'TopicIRMetricList' => [ 'base' => NULL, 'refs' => [ 'TopicIR$Metrics' => '

The metrics for the TopicIR.

', ], ], 'TopicId' => [ 'base' => NULL, 'refs' => [ 'BatchCreateTopicReviewedAnswerRequest$TopicId' => '

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchCreateTopicReviewedAnswerResponse$TopicId' => '

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchDeleteTopicReviewedAnswerRequest$TopicId' => '

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'BatchDeleteTopicReviewedAnswerResponse$TopicId' => '

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicRequest$TopicId' => '

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'CreateTopicResponse$TopicId' => '

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicRequest$TopicId' => '

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DeleteTopicResponse$TopicId' => '

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicPermissionsRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicPermissionsResponse$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicRequest$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'DescribeTopicResponse$TopicId' => '

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicRefreshSchedulesRequest$TopicId' => '

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicRefreshSchedulesResponse$TopicId' => '

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicReviewedAnswersRequest$TopicId' => '

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'ListTopicReviewedAnswersResponse$TopicId' => '

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'TopicSummary$TopicId' => '

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicPermissionsRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicPermissionsResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRefreshScheduleRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRefreshScheduleResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicRequest$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', 'UpdateTopicResponse$TopicId' => '

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', ], ], 'TopicNamedEntities' => [ 'base' => NULL, 'refs' => [ 'DatasetMetadata$NamedEntities' => '

The list of named entities definitions.

', ], ], 'TopicNamedEntity' => [ 'base' => '

A structure that represents a named entity.

', 'refs' => [ 'TopicNamedEntities$member' => NULL, ], ], 'TopicNumericEqualityFilter' => [ 'base' => '

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

', 'refs' => [ 'TopicFilter$NumericEqualityFilter' => '

The numeric equality filter.

', ], ], 'TopicNumericRangeFilter' => [ 'base' => '

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

', 'refs' => [ 'TopicFilter$NumericRangeFilter' => '

The numeric range filter.

', ], ], 'TopicNumericSeparatorSymbol' => [ 'base' => NULL, 'refs' => [ 'DisplayFormatOptions$DecimalSeparator' => '

Determines the decimal separator.

', ], ], 'TopicRangeFilterConstant' => [ 'base' => '

A constant value that is used in a range filter to specify the endpoints of the range.

', 'refs' => [ 'TopicDateRangeFilter$Constant' => '

The constant used in a date range filter.

', 'TopicNumericRangeFilter$Constant' => '

The constant used in a numeric range filter.

', ], ], 'TopicRefreshDetails' => [ 'base' => '

The details about the refresh of a topic.

', 'refs' => [ 'DescribeTopicRefreshResponse$RefreshDetails' => '

Details of the refresh, which is performed when the topic is created or updated.

', ], ], 'TopicRefreshSchedule' => [ 'base' => '

A structure that represents a topic refresh schedule.

', 'refs' => [ 'CreateTopicRefreshScheduleRequest$RefreshSchedule' => '

The definition of a refresh schedule.

', 'DescribeTopicRefreshScheduleResponse$RefreshSchedule' => '

The definition of a refresh schedule.

', 'TopicRefreshScheduleSummary$RefreshSchedule' => '

The definition of a refresh schedule.

', 'UpdateTopicRefreshScheduleRequest$RefreshSchedule' => '

The definition of a refresh schedule.

', ], ], 'TopicRefreshScheduleSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicRefreshSchedulesResponse$RefreshSchedules' => '

The list of topic refresh schedules.

', ], ], 'TopicRefreshScheduleSummary' => [ 'base' => '

A summary of the refresh schedule details for a dataset.

', 'refs' => [ 'TopicRefreshScheduleSummaries$member' => NULL, ], ], 'TopicRefreshStatus' => [ 'base' => NULL, 'refs' => [ 'TopicRefreshDetails$RefreshStatus' => '

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

', ], ], 'TopicRelativeDateFilter' => [ 'base' => '

A structure that represents a relative date filter.

', 'refs' => [ 'TopicFilter$RelativeDateFilter' => '

The relative date filter.

', ], ], 'TopicRelativeDateFilterFunction' => [ 'base' => NULL, 'refs' => [ 'TopicRelativeDateFilter$RelativeDateFilterFunction' => '

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

', ], ], 'TopicReviewedAnswer' => [ 'base' => '

The deinition for a TopicReviewedAnswer.

', 'refs' => [ 'TopicReviewedAnswers$member' => NULL, ], ], 'TopicReviewedAnswers' => [ 'base' => NULL, 'refs' => [ 'ListTopicReviewedAnswersResponse$Answers' => '

The definition of all Answers in the topic.

', ], ], 'TopicScheduleType' => [ 'base' => NULL, 'refs' => [ 'TopicRefreshSchedule$TopicScheduleType' => '

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

', ], ], 'TopicSingularFilterConstant' => [ 'base' => '

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

', 'refs' => [ 'TopicNumericEqualityFilter$Constant' => '

The constant used in a numeric equality filter.

', 'TopicRelativeDateFilter$Constant' => '

The constant used in a relative date filter.

', ], ], 'TopicSortClause' => [ 'base' => '

The definition for a TopicSortClause.

', 'refs' => [ 'TopicIR$Sort' => '

The sort for the TopicIR.

', 'TopicIRGroupBy$Sort' => '

The sort for the TopicIRGroupBy.

', ], ], 'TopicSortDirection' => [ 'base' => NULL, 'refs' => [ 'FilterAggMetrics$SortDirection' => '

The sort direction for FilterAggMetrics.

', 'TopicIRFilterOption$SortDirection' => '

The sort direction for the TopicIRFilterOption.

', 'TopicSortClause$SortDirection' => '

The sort direction for the TopicSortClause.

', ], ], 'TopicSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTopicsResponse$TopicsSummaries' => '

A list of topic summaries.

', ], ], 'TopicSummary' => [ 'base' => '

A topic summary.

', 'refs' => [ 'TopicSummaries$member' => NULL, ], ], 'TopicTemplate' => [ 'base' => '

The definition for a TopicTemplate.

', 'refs' => [ 'CreateTopicReviewedAnswer$Template' => '

The template for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$Template' => '

The template for the TopicReviewedAnswer.

', ], ], 'TopicTimeGranularity' => [ 'base' => NULL, 'refs' => [ 'AggFunction$Period' => '

The period of an Agg function.

', 'DataAggregation$DatasetRowDateGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicCalculatedField$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicColumn$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', 'TopicIRComparisonMethod$Period' => '

The period for the TopicIRComparisonMethod.

', 'TopicIRGroupBy$TimeGranularity' => '

The time granularity for the TopicIRGroupBy.

', 'TopicRelativeDateFilter$TimeGranularity' => '

The level of time precision that is used to aggregate DateTime values.

', ], ], 'TopicUserExperienceVersion' => [ 'base' => NULL, 'refs' => [ 'TopicDetails$UserExperienceVersion' => '

The user experience version of a topic.

', 'TopicSummary$UserExperienceVersion' => '

The user experience version of the topic.

', ], ], 'TopicVisual' => [ 'base' => '

The definition for a TopicVisual.

', 'refs' => [ 'CreateTopicReviewedAnswer$PrimaryVisual' => '

The PrimaryVisual for the CreateTopicReviewedAnswer.

', 'TopicReviewedAnswer$PrimaryVisual' => '

The primary visual for the TopicReviewedAnswer.

', 'TopicVisuals$member' => NULL, ], ], 'TopicVisuals' => [ 'base' => NULL, 'refs' => [ 'TopicVisual$SupportingVisuals' => '

The supporting visuals for the TopicVisual.

', ], ], 'TotalAggregationComputation' => [ 'base' => '

The total aggregation computation configuration.

', 'refs' => [ 'Computation$TotalAggregation' => '

The total aggregation computation configuration.

', ], ], 'TotalAggregationFunction' => [ 'base' => '

An aggregation function that aggregates the total values of a measure.

', 'refs' => [ 'TotalAggregationOption$TotalAggregationFunction' => '

The total aggregation function that you want to set for a specified field id.

', ], ], 'TotalAggregationOption' => [ 'base' => '

The total aggregation settings map of a field id.

', 'refs' => [ 'TotalAggregationOptionList$member' => NULL, ], ], 'TotalAggregationOptionList' => [ 'base' => NULL, 'refs' => [ 'PivotTotalOptions$TotalAggregationOptions' => '

The total aggregation options for each value field.

', 'TotalOptions$TotalAggregationOptions' => '

The total aggregation settings for each value field.

', ], ], 'TotalOptions' => [ 'base' => '

The total options for a table visual.

', 'refs' => [ 'TableConfiguration$TotalOptions' => '

The total options for a table visual.

', ], ], 'TransformOperation' => [ 'base' => '

A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

', 'refs' => [ 'TransformOperationList$member' => NULL, ], ], 'TransformOperationList' => [ 'base' => NULL, 'refs' => [ 'LogicalTable$DataTransforms' => '

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

', ], ], 'TreeMapAggregatedFieldWells' => [ 'base' => '

Aggregated field wells of a tree map.

', 'refs' => [ 'TreeMapFieldWells$TreeMapAggregatedFieldWells' => '

The aggregated field wells of a tree map.

', ], ], 'TreeMapConfiguration' => [ 'base' => '

The configuration of a tree map.

', 'refs' => [ 'TreeMapVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'TreeMapDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'TreeMapAggregatedFieldWells$Groups' => '

The group by field well of a tree map. Values are grouped based on group by fields.

', ], ], 'TreeMapFieldWells' => [ 'base' => '

The field wells of a tree map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'TreeMapConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'TreeMapMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'TreeMapAggregatedFieldWells$Sizes' => '

The size field well of a tree map. Values are aggregated based on group by fields.

', 'TreeMapAggregatedFieldWells$Colors' => '

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

', ], ], 'TreeMapSortConfiguration' => [ 'base' => '

The sort configuration of a tree map.

', 'refs' => [ 'TreeMapConfiguration$SortConfiguration' => '

The sort configuration of a tree map.

', ], ], 'TreeMapVisual' => [ 'base' => '

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$TreeMapVisual' => '

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

', ], ], 'TrendArrowOptions' => [ 'base' => '

The options that determine the presentation of trend arrows in a KPI visual.

', 'refs' => [ 'KPIOptions$TrendArrows' => '

The options that determine the presentation of trend arrows in a KPI visual.

', ], ], 'TrinoParameters' => [ 'base' => '

The parameters that are required to connect to a Trino data source.

', 'refs' => [ 'DataSourceParameters$TrinoParameters' => '

The parameters that are required to connect to a Trino data source.

', ], ], 'TwitterParameters' => [ 'base' => '

The parameters for Twitter.

', 'refs' => [ 'DataSourceParameters$TwitterParameters' => '

The parameters for Twitter.

', ], ], 'TypeCastFormat' => [ 'base' => NULL, 'refs' => [ 'CastColumnTypeOperation$Format' => '

When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.

', ], ], 'TypeParameters' => [ 'base' => NULL, 'refs' => [ 'SemanticEntityType$TypeParameters' => '

The semantic entity type parameters.

', 'SemanticType$TypeParameters' => '

The semantic type parameters.

', ], ], 'Typography' => [ 'base' => '

Determines the typography options.

', 'refs' => [ 'ThemeConfiguration$Typography' => NULL, ], ], 'UIColorPalette' => [ 'base' => '

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

', 'refs' => [ 'ThemeConfiguration$UIColorPalette' => '

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

', ], ], 'URLOperationTemplate' => [ 'base' => NULL, 'refs' => [ 'CustomActionURLOperation$URLTemplate' => '

THe URL link of the CustomActionURLOperation.

', 'CustomContentConfiguration$ContentUrl' => '

The input URL that links to the custom content that you want in the custom visual.

', ], ], 'URLTargetConfiguration' => [ 'base' => NULL, 'refs' => [ 'CustomActionURLOperation$URLTarget' => '

The target of the CustomActionURLOperation.

Valid values are defined as follows:

', 'TableFieldLinkConfiguration$Target' => '

The URL target (new tab, new window, same tab) for the table link configuration.

', ], ], 'UnaggregatedField' => [ 'base' => '

The unaggregated field for a table.

', 'refs' => [ 'UnaggregatedFieldList$member' => NULL, ], ], 'UnaggregatedFieldList' => [ 'base' => NULL, 'refs' => [ 'TableUnaggregatedFieldWells$Values' => '

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

', ], ], 'UndefinedSpecifiedValueType' => [ 'base' => NULL, 'refs' => [ 'ComparativeOrder$TreatUndefinedSpecifiedValues' => '

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

', ], ], 'UnicodeIcon' => [ 'base' => NULL, 'refs' => [ 'ConditionalFormattingCustomIconOptions$UnicodeIcon' => '

Determines the Unicode icon type.

', ], ], 'UniqueValuesComputation' => [ 'base' => '

The unique values computation configuration.

', 'refs' => [ 'Computation$UniqueValues' => '

The unique values computation configuration.

', ], ], 'UnlimitedPixelLength' => [ 'base' => 'String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value', 'refs' => [ 'FreeFormLayoutElement$YAxisLocation' => '

The y-axis coordinate of the element.

', ], ], 'UnsupportedPricingPlanException' => [ 'base' => '

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.

', 'refs' => [], ], 'UnsupportedUserEditionException' => [ 'base' => '

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.

', 'refs' => [], ], 'UntagColumnOperation' => [ 'base' => '

A transform operation that removes tags associated with a column.

', 'refs' => [ 'TransformOperation$UntagColumnOperation' => NULL, ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountCustomizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountCustomizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardLinksResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPublishedVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardPublishedVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDashboardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourcePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourcePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFolderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIAMPolicyAssignmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIAMPolicyAssignmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityPropagationConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIdentityPropagationConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpRestrictionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIpRestrictionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKeyRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKeyRegistrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkPermissionList' => [ 'base' => NULL, 'refs' => [ 'UpdateDashboardPermissionsRequest$GrantLinkPermissions' => '

Grants link permissions to all users in a defined namespace.

', 'UpdateDashboardPermissionsRequest$RevokeLinkPermissions' => '

Revokes link permissions from all users in a defined namespace.

', ], ], 'UpdatePublicSharingSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePublicSharingSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourcePermissionList' => [ 'base' => NULL, 'refs' => [ 'UpdateAnalysisPermissionsRequest$GrantPermissions' => '

A structure that describes the permissions to add and the principal to add them to.

', 'UpdateAnalysisPermissionsRequest$RevokePermissions' => '

A structure that describes the permissions to remove and the principal to remove them from.

', 'UpdateDashboardPermissionsRequest$GrantPermissions' => '

The permissions that you want to grant on this resource.

', 'UpdateDashboardPermissionsRequest$RevokePermissions' => '

The permissions that you want to revoke from this resource.

', 'UpdateTemplatePermissionsRequest$GrantPermissions' => '

A list of resource permissions to be granted on the template.

', 'UpdateTemplatePermissionsRequest$RevokePermissions' => '

A list of resource permissions to be revoked from the template.

', 'UpdateThemePermissionsRequest$GrantPermissions' => '

A list of resource permissions to be granted for the theme.

', 'UpdateThemePermissionsRequest$RevokePermissions' => '

A list of resource permissions to be revoked from the theme.

', 'UpdateTopicPermissionsRequest$GrantPermissions' => '

The resource permissions that you want to grant to the topic.

', 'UpdateTopicPermissionsRequest$RevokePermissions' => '

The resource permissions that you want to revoke from the topic.

', ], ], 'UpdateRoleCustomPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoleCustomPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSPICECapacityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSPICECapacityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplatePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplatePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateThemeResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRefreshScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRefreshScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTopicResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UploadSettings' => [ 'base' => '

Information about the format for a source file or files.

', 'refs' => [ 'S3Source$UploadSettings' => '

Information about the format for the S3 source file or files.

', ], ], 'User' => [ 'base' => '

A registered user of Amazon QuickSight.

', 'refs' => [ 'DescribeUserResponse$User' => '

The user name.

', 'RegisterUserResponse$User' => '

The user\'s user name.

', 'UpdateUserResponse$User' => '

The Amazon QuickSight user.

', 'UserList$member' => NULL, ], ], 'UserList' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$UserList' => '

The list of users.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'DeleteUserRequest$UserName' => '

The name of the user that you want to delete.

', 'DescribeUserRequest$UserName' => '

The name of the user that you want to describe.

', 'ListIAMPolicyAssignmentsForUserRequest$UserName' => '

The name of the user.

', 'ListUserGroupsRequest$UserName' => '

The Amazon QuickSight user name that you want to list group memberships for.

', 'RegisterUserRequest$UserName' => '

The Amazon QuickSight user name that you want to create for the user you are registering.

', 'UpdateUserRequest$UserName' => '

The Amazon QuickSight user name that you want to update.

', 'User$UserName' => '

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.

', ], ], 'UserRole' => [ 'base' => NULL, 'refs' => [ 'RegisterUserRequest$UserRole' => '

The Amazon QuickSight role for the user. The user role can be one of the following:

', 'UpdateUserRequest$Role' => '

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

', 'User$Role' => '

The Amazon QuickSight role for the user. The user role can be one of the following:.

', ], ], 'VPCConnection' => [ 'base' => '

The structure of a VPC connection.

', 'refs' => [ 'DescribeVPCConnectionResponse$VPCConnection' => '

A response object that provides information for the specified VPC connection.

', ], ], 'VPCConnectionAvailabilityStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'DeleteVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'UpdateVPCConnectionResponse$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'VPCConnection$AvailabilityStatus' => '

The availability status of the VPC connection.

', 'VPCConnectionSummary$AvailabilityStatus' => '

The availability status of the VPC connection.

', ], ], 'VPCConnectionResourceIdRestricted' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'CreateVPCConnectionResponse$VPCConnectionId' => '

The ID for the VPC connection that you\'re creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

', ], ], 'VPCConnectionResourceIdUnrestricted' => [ 'base' => NULL, 'refs' => [ 'AssetBundleImportJobVPCConnectionOverrideParameters$VPCConnectionId' => '

The ID of the VPC Connection to apply overrides to.

', 'DeleteVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteVPCConnectionResponse$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'UpdateVPCConnectionRequest$VPCConnectionId' => '

The ID of the VPC connection that you\'re updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'UpdateVPCConnectionResponse$VPCConnectionId' => '

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

', 'VPCConnection$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', 'VPCConnectionSummary$VPCConnectionId' => '

The ID of the VPC connection that you\'re creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

', ], ], 'VPCConnectionResourceStatus' => [ 'base' => NULL, 'refs' => [ 'CreateVPCConnectionResponse$CreationStatus' => '

The status of the creation of the VPC connection.

', 'DeleteVPCConnectionResponse$DeletionStatus' => '

The deletion status of the VPC connection.

', 'UpdateVPCConnectionResponse$UpdateStatus' => '

The update status of the VPC connection\'s last update.

', 'VPCConnection$Status' => '

The status of the VPC connection.

', 'VPCConnectionSummary$Status' => '

The status of the VPC connection.

', ], ], 'VPCConnectionSummary' => [ 'base' => '

The summary metadata that describes a VPC connection.

', 'refs' => [ 'VPCConnectionSummaryList$member' => NULL, ], ], 'VPCConnectionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVPCConnectionsResponse$VPCConnectionSummaries' => '

A VPCConnectionSummaries object that returns a summary of VPC connection objects.

', ], ], 'ValidationStrategy' => [ 'base' => '

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

', 'refs' => [ 'CreateAnalysisRequest$ValidationStrategy' => '

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

', 'CreateDashboardRequest$ValidationStrategy' => '

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

', 'CreateTemplateRequest$ValidationStrategy' => '

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

', 'UpdateAnalysisRequest$ValidationStrategy' => '

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

', 'UpdateDashboardRequest$ValidationStrategy' => '

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

', 'UpdateTemplateRequest$ValidationStrategy' => '

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

', ], ], 'ValidationStrategyMode' => [ 'base' => NULL, 'refs' => [ 'ValidationStrategy$Mode' => '

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

', ], ], 'ValueWhenUnsetOption' => [ 'base' => NULL, 'refs' => [ 'DateTimeValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'DecimalValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'IntegerValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', 'StringValueWhenUnsetConfiguration$ValueWhenUnsetOption' => '

The built-in options for default values. The value can be one of the following:

', ], ], 'VersionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDashboardRequest$VersionDescription' => '

A description for the first version of the dashboard being created.

', 'CreateTemplateRequest$VersionDescription' => '

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

', 'CreateThemeRequest$VersionDescription' => '

A description of the first version of the theme that you\'re creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

', 'DashboardVersion$Description' => '

Description.

', 'DashboardVersionSummary$Description' => '

Description.

', 'TemplateVersion$Description' => '

The description of the template.

', 'TemplateVersionSummary$Description' => '

The description of the template version.

', 'ThemeVersion$Description' => '

The description of the theme.

', 'ThemeVersionSummary$Description' => '

The description of the theme version.

', 'UpdateDashboardRequest$VersionDescription' => '

A description for the first version of the dashboard being created.

', 'UpdateTemplateRequest$VersionDescription' => '

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

', 'UpdateThemeRequest$VersionDescription' => '

A description of the theme version that you\'re updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

', ], ], 'VersionNumber' => [ 'base' => NULL, 'refs' => [ 'CreateTemplateAliasRequest$TemplateVersionNumber' => '

The version number of the template.

', 'CreateThemeAliasRequest$ThemeVersionNumber' => '

The version number of the theme.

', 'DashboardSummary$PublishedVersionNumber' => '

Published version number.

', 'DashboardVersion$VersionNumber' => '

Version number for this version of the dashboard.

', 'DashboardVersionSummary$VersionNumber' => '

Version number.

', 'DeleteDashboardRequest$VersionNumber' => '

The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

', 'DeleteTemplateRequest$VersionNumber' => '

Specifies the version of the template that you want to delete. If you don\'t provide a version number, DeleteTemplate deletes all versions of the template.

', 'DeleteThemeRequest$VersionNumber' => '

The version of the theme that you want to delete.

Note: If you don\'t provide a version number, you\'re using this call to DeleteTheme to delete all versions of the theme.

', 'DescribeDashboardDefinitionRequest$VersionNumber' => '

The version number for the dashboard. If a version number isn\'t passed, the latest published dashboard version is described.

', 'DescribeDashboardRequest$VersionNumber' => '

The version number for the dashboard. If a version number isn\'t passed, the latest published dashboard version is described.

', 'DescribeTemplateDefinitionRequest$VersionNumber' => '

The version number of the template.

', 'DescribeTemplateRequest$VersionNumber' => '

(Optional) The number for the version to describe. If a VersionNumber parameter value isn\'t provided, the latest version of the template is described.

', 'DescribeThemeRequest$VersionNumber' => '

The version number for the version to describe. If a VersionNumber parameter value isn\'t provided, the latest version of the theme is described.

', 'TemplateAlias$TemplateVersionNumber' => '

The version number of the template alias.

', 'TemplateSummary$LatestVersionNumber' => '

A structure containing a list of version numbers for the template summary.

', 'TemplateVersion$VersionNumber' => '

The version number of the template version.

', 'TemplateVersionSummary$VersionNumber' => '

The version number of the template version.

', 'ThemeAlias$ThemeVersionNumber' => '

The version number of the theme alias.

', 'ThemeSummary$LatestVersionNumber' => '

The latest version number for the theme.

', 'ThemeVersion$VersionNumber' => '

The version number of the theme.

', 'ThemeVersionSummary$VersionNumber' => '

The version number of the theme version.

', 'UpdateDashboardPublishedVersionRequest$VersionNumber' => '

The version number of the dashboard.

', 'UpdateTemplateAliasRequest$TemplateVersionNumber' => '

The version number of the template.

', 'UpdateThemeAliasRequest$ThemeVersionNumber' => '

The version number of the theme that the alias should reference.

', ], ], 'VerticalTextAlignment' => [ 'base' => NULL, 'refs' => [ 'TableCellStyle$VerticalTextAlignment' => '

The vertical text alignment (top, middle, bottom) for the table cells.

', ], ], 'Visibility' => [ 'base' => NULL, 'refs' => [ 'AxisDisplayOptions$AxisLineVisibility' => '

Determines whether or not the axis line is visible.

', 'AxisDisplayOptions$GridLineVisibility' => '

Determines whether or not the grid line is visible.

', 'BoxPlotOptions$OutlierVisibility' => '

Determines the visibility of the outlier in a box plot.

', 'BoxPlotOptions$AllDataPointsVisibility' => '

Determines the visibility of all data points of the box plot.

', 'ChartAxisLabelOptions$Visibility' => '

The visibility of an axis label on a chart. Choose one of the following options:

', 'ChartAxisLabelOptions$SortIconVisibility' => '

The visibility configuration of the sort icon on a chart\'s axis label.

', 'ColumnTooltipItem$Visibility' => '

The visibility of the tooltip item.

', 'DataLabelOptions$Visibility' => '

Determines the visibility of the data labels.

', 'DataLabelOptions$CategoryLabelVisibility' => '

Determines the visibility of the category field labels.

', 'DataLabelOptions$MeasureLabelVisibility' => '

Determines the visibility of the measure field labels.

', 'DataLabelOptions$TotalsVisibility' => '

Determines the visibility of the total.

', 'DataPathLabelType$Visibility' => '

The visibility of the data label.

', 'DateAxisOptions$MissingDateVisibility' => '

Determines whether or not missing dates are displayed.

', 'DateTimePickerControlDisplayOptions$HelperTextVisibility' => '

The helper text visibility of the DateTimePickerControlDisplayOptions.

', 'DateTimePickerControlDisplayOptions$DateIconVisibility' => '

The date icon visibility of the DateTimePickerControlDisplayOptions.

', 'DonutCenterOptions$LabelVisibility' => '

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called \'Show total\'.

', 'FieldBasedTooltip$AggregationVisibility' => '

The visibility of Show aggregations.

', 'FieldLabelType$Visibility' => '

The visibility of the field label.

', 'FieldTooltipItem$Visibility' => '

The visibility of the tooltip item.

', 'FreeFormLayoutElement$Visibility' => '

The visibility of an element within a free-form layout.

', 'FreeFormLayoutElementBackgroundStyle$Visibility' => '

The background visibility of a free-form layout element.

', 'FreeFormLayoutElementBorderStyle$Visibility' => '

The border visibility of a free-form layout element.

', 'FunnelChartDataLabelOptions$Visibility' => '

The visibility option that determines if data labels are displayed.

', 'FunnelChartDataLabelOptions$CategoryLabelVisibility' => '

The visibility of the category labels within the data labels.

', 'FunnelChartDataLabelOptions$MeasureLabelVisibility' => '

The visibility of the measure labels within the data labels.

', 'KPISparklineOptions$Visibility' => '

The visibility of the sparkline.

', 'KPISparklineOptions$TooltipVisibility' => '

The tooltip visibility of the sparkline.

', 'LabelOptions$Visibility' => '

Determines whether or not the label is visible.

', 'LegendOptions$Visibility' => '

Determines whether or not the legend is visible.

', 'LineChartLineStyleSettings$LineVisibility' => '

Configuration option that determines whether to show the line for the series.

', 'LineChartMarkerStyleSettings$MarkerVisibility' => '

Configuration option that determines whether to show the markers in the series.

', 'ListControlSearchOptions$Visibility' => '

The visibility configuration of the search options in a list control.

', 'ListControlSelectAllOptions$Visibility' => '

The visibility configuration of the Select all options in a list control.

', 'LoadingAnimation$Visibility' => '

The visibility configuration of LoadingAnimation.

', 'MaximumLabelType$Visibility' => '

The visibility of the maximum label.

', 'MinimumLabelType$Visibility' => '

The visibility of the minimum label.

', 'PanelConfiguration$BorderVisibility' => '

Determines whether or not each panel displays a border.

', 'PanelConfiguration$GutterVisibility' => '

Determines whether or not negative space between sibling panels is rendered.

', 'PanelConfiguration$BackgroundVisibility' => '

Determines whether or not a background for each small multiples panel is rendered.

', 'PanelTitleOptions$Visibility' => '

Determines whether or not panel titles are displayed.

', 'PivotTableFieldOption$Visibility' => '

The visibility of the pivot table field.

', 'PivotTableOptions$SingleMetricVisibility' => '

The visibility of the single metric options.

', 'PivotTableOptions$ColumnNamesVisibility' => '

The visibility of the column names.

', 'PivotTableOptions$ToggleButtonsVisibility' => '

Determines the visibility of the pivot table.

', 'PivotTableOptions$CollapsedRowDimensionsVisibility' => '

The visibility setting of a pivot table\'s collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

', 'PivotTablePaginatedReportOptions$VerticalOverflowVisibility' => '

The visibility of the printing table overflow across pages.

', 'PivotTablePaginatedReportOptions$OverflowColumnHeaderVisibility' => '

The visibility of the repeating header rows on each page.

', 'PivotTableRowsLabelOptions$Visibility' => '

The visibility of the rows label.

', 'PivotTotalOptions$TotalsVisibility' => '

The visibility configuration for the total cells.

', 'ProgressBarOptions$Visibility' => '

The visibility of the progress bar.

', 'RadarChartAreaStyleSettings$Visibility' => '

The visibility settings of a radar chart.

', 'RadarChartConfiguration$AlternateBandColorsVisibility' => '

Determines the visibility of the colors of alternatign bands in a radar chart.

', 'RangeEndsLabelType$Visibility' => '

The visibility of the range ends label.

', 'ScrollBarOptions$Visibility' => '

The visibility of the data zoom scroll bar.

', 'SecondaryValueOptions$Visibility' => '

Determines the visibility of the secondary value.

', 'SheetControlInfoIconLabelOptions$Visibility' => '

The visibility configuration of info icon label options.

', 'SheetElementConfigurationOverrides$Visibility' => '

Determines whether or not the overrides are visible. Choose one of the following options:

', 'SubtotalOptions$TotalsVisibility' => '

The visibility configuration for the subtotal cells.

', 'TableCellStyle$Visibility' => '

The visibility of the table cells.

', 'TableFieldOption$Visibility' => '

The visibility of a table field.

', 'TablePaginatedReportOptions$VerticalOverflowVisibility' => '

The visibility of printing table overflow across pages.

', 'TablePaginatedReportOptions$OverflowColumnHeaderVisibility' => '

The visibility of repeating header rows on each page.

', 'TextControlPlaceholderOptions$Visibility' => '

The visibility configuration of the placeholder options in a text control.

', 'ThousandSeparatorOptions$Visibility' => '

Determines the visibility of the thousands separator.

', 'TooltipOptions$TooltipVisibility' => '

Determines whether or not the tooltip is visible.

', 'TotalOptions$TotalsVisibility' => '

The visibility configuration for the total cells.

', 'TrendArrowOptions$Visibility' => '

The visibility of the trend arrows.

', 'VisualSubtitleLabelOptions$Visibility' => '

The visibility of the subtitle label.

', 'VisualTitleLabelOptions$Visibility' => '

The visibility of the title label.

', ], ], 'VisiblePanelColumns' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesOptions$MaxVisibleColumns' => '

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

', ], ], 'VisiblePanelRows' => [ 'base' => NULL, 'refs' => [ 'SmallMultiplesOptions$MaxVisibleRows' => '

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

', ], ], 'VisibleRangeOptions' => [ 'base' => '

The range options for the data zoom scroll bar.

', 'refs' => [ 'ScrollBarOptions$VisibleRange' => '

The visibility range for the data zoom scroll bar.

', ], ], 'Visual' => [ 'base' => '

A visual displayed on a sheet in an analysis, dashboard, or template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualList$member' => NULL, ], ], 'VisualAxisSortOption' => [ 'base' => '

The axis sort options for a visual.

', 'refs' => [ 'DashboardPublishOptions$VisualAxisSortOption' => '

The axis sort options of a dashboard.

', ], ], 'VisualCustomAction' => [ 'base' => '

A custom action defined on a visual.

', 'refs' => [ 'VisualCustomActionList$member' => NULL, ], ], 'VisualCustomActionList' => [ 'base' => NULL, 'refs' => [ 'BarChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'BoxPlotVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'ComboChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'CustomContentVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'EmptyVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'FilledMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'FunnelChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'GaugeChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'GeospatialMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'HeatMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'HistogramVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'InsightVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'KPIVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'LineChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'PieChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'PivotTableVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'RadarChartVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'SankeyDiagramVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'ScatterPlotVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'TableVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'TreeMapVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'WaterfallVisual$Actions' => '

The list of custom actions that are configured for a visual.

', 'WordCloudVisual$Actions' => '

The list of custom actions that are configured for a visual.

', ], ], 'VisualCustomActionName' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$Name' => '

The name of the VisualCustomAction.

', ], ], 'VisualCustomActionOperation' => [ 'base' => '

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'VisualCustomActionOperationList$member' => NULL, ], ], 'VisualCustomActionOperationList' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$ActionOperations' => '

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', ], ], 'VisualCustomActionTrigger' => [ 'base' => NULL, 'refs' => [ 'VisualCustomAction$Trigger' => '

The trigger of the VisualCustomAction.

Valid values are defined as follows:

', ], ], 'VisualInteractionOptions' => [ 'base' => '

The general visual interactions setup for visual publish options

', 'refs' => [ 'BarChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'BoxPlotChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'ComboChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'CustomContentConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'FilledMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'FunnelChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'GaugeChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'GeospatialMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'HeatMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'HistogramConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'InsightConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'KPIConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'LineChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'PieChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'PivotTableConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'RadarChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'SankeyDiagramChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'ScatterPlotConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'TableConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'TreeMapConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'WaterfallChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', 'WordCloudChartConfiguration$Interactions' => '

The general visual interactions setup for a visual.

', ], ], 'VisualList' => [ 'base' => NULL, 'refs' => [ 'SheetDefinition$Visuals' => '

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

', ], ], 'VisualMenuOption' => [ 'base' => '

The menu options for a visual.

', 'refs' => [ 'DashboardPublishOptions$VisualMenuOption' => '

The menu options of a visual in a dashboard.

', 'VisualInteractionOptions$VisualMenuOption' => '

The on-visual menu options for a visual.

', ], ], 'VisualOptions' => [ 'base' => '

The definition for a VisualOptions.

', 'refs' => [ 'TopicIR$Visual' => '

The visual for the TopicIR.

', ], ], 'VisualPalette' => [ 'base' => '

The visual display options for the visual palette.

', 'refs' => [ 'BarChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'BoxPlotChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'ComboChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'FunnelChartConfiguration$VisualPalette' => '

The visual palette configuration of a FunnelChartVisual.

', 'GaugeChartConfiguration$VisualPalette' => '

The visual palette configuration of a GaugeChartVisual.

', 'GeospatialMapConfiguration$VisualPalette' => NULL, 'HistogramConfiguration$VisualPalette' => '

The visual palette configuration of a histogram.

', 'LineChartConfiguration$VisualPalette' => '

The visual palette configuration of a line chart.

', 'PieChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'RadarChartConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'ScatterPlotConfiguration$VisualPalette' => '

The palette (chart color) display setup of the visual.

', 'WaterfallChartConfiguration$VisualPalette' => '

The visual palette configuration of a waterfall visual.

', ], ], 'VisualRole' => [ 'base' => NULL, 'refs' => [ 'TopicVisual$Role' => '

The role for the TopicVisual.

', ], ], 'VisualSubtitleLabelOptions' => [ 'base' => '

The subtitle label options for a visual.

', 'refs' => [ 'BarChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'BoxPlotVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'ComboChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'CustomContentVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'FilledMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'FunnelChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'GaugeChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'GeospatialMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'HeatMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'HistogramVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'InsightVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'KPIVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'LineChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'PieChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'PivotTableVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'RadarChartVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'SankeyDiagramVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'ScatterPlotVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'TableVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'TreeMapVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'WaterfallVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', 'WordCloudVisual$Subtitle' => '

The subtitle that is displayed on the visual.

', ], ], 'VisualTitleLabelOptions' => [ 'base' => '

The title label options for a visual.

', 'refs' => [ 'BarChartVisual$Title' => '

The title that is displayed on the visual.

', 'BoxPlotVisual$Title' => '

The title that is displayed on the visual.

', 'ComboChartVisual$Title' => '

The title that is displayed on the visual.

', 'CustomContentVisual$Title' => '

The title that is displayed on the visual.

', 'FilledMapVisual$Title' => '

The title that is displayed on the visual.

', 'FunnelChartVisual$Title' => '

The title that is displayed on the visual.

', 'GaugeChartVisual$Title' => '

The title that is displayed on the visual.

', 'GeospatialMapVisual$Title' => '

The title that is displayed on the visual.

', 'HeatMapVisual$Title' => '

The title that is displayed on the visual.

', 'HistogramVisual$Title' => '

The title that is displayed on the visual.

', 'InsightVisual$Title' => '

The title that is displayed on the visual.

', 'KPIVisual$Title' => '

The title that is displayed on the visual.

', 'LineChartVisual$Title' => '

The title that is displayed on the visual.

', 'PieChartVisual$Title' => '

The title that is displayed on the visual.

', 'PivotTableVisual$Title' => '

The title that is displayed on the visual.

', 'RadarChartVisual$Title' => '

The title that is displayed on the visual.

', 'SankeyDiagramVisual$Title' => '

The title that is displayed on the visual.

', 'ScatterPlotVisual$Title' => '

The title that is displayed on the visual.

', 'TableVisual$Title' => '

The title that is displayed on the visual.

', 'TreeMapVisual$Title' => '

The title that is displayed on the visual.

', 'WaterfallVisual$Title' => '

The title that is displayed on the visual.

', 'WordCloudVisual$Title' => '

The title that is displayed on the visual.

', ], ], 'VpcConnectionProperties' => [ 'base' => '

VPC connection properties.

', 'refs' => [ 'AssetBundleImportJobDataSourceOverrideParameters$VpcConnectionProperties' => NULL, 'CreateDataSourceRequest$VpcConnectionProperties' => '

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

', 'DataSource$VpcConnectionProperties' => '

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.

', 'UpdateDataSourceRequest$VpcConnectionProperties' => '

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointIdRestrictionRuleMap$key' => NULL, ], ], 'VpcEndpointIdRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointIdRestrictionRuleMap$value' => NULL, ], ], 'VpcEndpointIdRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$VpcEndpointIdRestrictionRuleMap' => '

A map of allowed VPC endpoint IDs and their rule descriptions.

', 'UpdateIpRestrictionRequest$VpcEndpointIdRestrictionRuleMap' => '

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcIdRestrictionRuleMap$key' => NULL, ], ], 'VpcIdRestrictionRuleDescription' => [ 'base' => NULL, 'refs' => [ 'VpcIdRestrictionRuleMap$value' => NULL, ], ], 'VpcIdRestrictionRuleMap' => [ 'base' => NULL, 'refs' => [ 'DescribeIpRestrictionResponse$VpcIdRestrictionRuleMap' => '

A map of allowed VPC IDs and their rule descriptions.

', 'UpdateIpRestrictionRequest$VpcIdRestrictionRuleMap' => '

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

', ], ], 'Warehouse' => [ 'base' => NULL, 'refs' => [ 'SnowflakeParameters$Warehouse' => '

Warehouse.

', ], ], 'WaterfallChartAggregatedFieldWells' => [ 'base' => '

The field well configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartFieldWells$WaterfallChartAggregatedFieldWells' => '

The field well configuration of a waterfall visual.

', ], ], 'WaterfallChartColorConfiguration' => [ 'base' => '

The color configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$ColorConfiguration' => '

The color configuration of a waterfall visual.

', ], ], 'WaterfallChartConfiguration' => [ 'base' => '

The configuration for a waterfall visual.

', 'refs' => [ 'WaterfallVisual$ChartConfiguration' => '

The configuration for a waterfall visual.

', ], ], 'WaterfallChartFieldWells' => [ 'base' => '

The field well configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$FieldWells' => '

The field well configuration of a waterfall visual.

', ], ], 'WaterfallChartGroupColorConfiguration' => [ 'base' => '

The color configuration for individual groups within a waterfall visual.

', 'refs' => [ 'WaterfallChartColorConfiguration$GroupColorConfiguration' => '

The color configuration for individual groups within a waterfall visual.

', ], ], 'WaterfallChartOptions' => [ 'base' => '

The options that determine the presentation of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$WaterfallChartOptions' => '

The options that determine the presentation of a waterfall visual.

', ], ], 'WaterfallChartSortConfiguration' => [ 'base' => '

The sort configuration of a waterfall visual.

', 'refs' => [ 'WaterfallChartConfiguration$SortConfiguration' => '

The sort configuration of a waterfall visual.

', ], ], 'WaterfallVisual' => [ 'base' => '

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$WaterfallVisual' => '

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

', ], ], 'WhatIfPointScenario' => [ 'base' => '

Provides the forecast to meet the target for a particular date.

', 'refs' => [ 'ForecastScenario$WhatIfPointScenario' => '

The what-if analysis forecast setup with the target date.

', ], ], 'WhatIfRangeScenario' => [ 'base' => '

Provides the forecast to meet the target for a particular date range.

', 'refs' => [ 'ForecastScenario$WhatIfRangeScenario' => '

The what-if analysis forecast setup with the date range.

', ], ], 'WidgetStatus' => [ 'base' => NULL, 'refs' => [ 'ExcludePeriodConfiguration$Status' => '

The status of the exclude period. Choose from the following options:

', 'FilterGroup$Status' => '

The status of the FilterGroup.

', 'ReferenceLine$Status' => '

The status of the reference line. Choose one of the following options:

', 'RowAlternateColorOptions$Status' => '

Determines the widget status.

', 'RowAlternateColorOptions$UsePrimaryBackgroundColor' => '

The primary background color options for alternate rows.

', 'VisualCustomAction$Status' => '

The status of the VisualCustomAction.

', ], ], 'WordCloudAggregatedFieldWells' => [ 'base' => '

The aggregated field wells of a word cloud.

', 'refs' => [ 'WordCloudFieldWells$WordCloudAggregatedFieldWells' => '

The aggregated field wells of a word cloud.

', ], ], 'WordCloudChartConfiguration' => [ 'base' => '

The configuration of a word cloud visual.

', 'refs' => [ 'WordCloudVisual$ChartConfiguration' => '

The configuration settings of the visual.

', ], ], 'WordCloudCloudLayout' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$CloudLayout' => '

The cloud layout options (fluid, normal) of a word cloud.

', ], ], 'WordCloudDimensionFieldList' => [ 'base' => NULL, 'refs' => [ 'WordCloudAggregatedFieldWells$GroupBy' => '

The group by field well of a word cloud. Values are grouped by group by fields.

', ], ], 'WordCloudFieldWells' => [ 'base' => '

The field wells of a word cloud visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

', 'refs' => [ 'WordCloudChartConfiguration$FieldWells' => '

The field wells of the visual.

', ], ], 'WordCloudMaximumStringLength' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$MaximumStringLength' => '

The length limit of each word from 1-100.

', ], ], 'WordCloudMeasureFieldList' => [ 'base' => NULL, 'refs' => [ 'WordCloudAggregatedFieldWells$Size' => '

The size field well of a word cloud. Values are aggregated based on group by fields.

', ], ], 'WordCloudOptions' => [ 'base' => '

The word cloud options for a word cloud visual.

', 'refs' => [ 'WordCloudChartConfiguration$WordCloudOptions' => '

The options for a word cloud visual.

', ], ], 'WordCloudSortConfiguration' => [ 'base' => '

The sort configuration of a word cloud visual.

', 'refs' => [ 'WordCloudChartConfiguration$SortConfiguration' => '

The sort configuration of a word cloud visual.

', ], ], 'WordCloudVisual' => [ 'base' => '

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

', 'refs' => [ 'Visual$WordCloudVisual' => '

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

', ], ], 'WordCloudWordCasing' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordCasing' => '

The word casing options (lower_case, existing_case) for the words in a word cloud.

', ], ], 'WordCloudWordOrientation' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordOrientation' => '

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

', ], ], 'WordCloudWordPadding' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordPadding' => '

The word padding options (none, small, medium, large) for the words in a word cloud.

', ], ], 'WordCloudWordScaling' => [ 'base' => NULL, 'refs' => [ 'WordCloudOptions$WordScaling' => '

The word scaling options (emphasize, normal) for the words in a word cloud.

', ], ], 'WorkGroup' => [ 'base' => NULL, 'refs' => [ 'AthenaParameters$WorkGroup' => '

The workgroup that Amazon Athena uses.

', ], ], 'YAxisOptions' => [ 'base' => '

The options that are available for a single Y axis in a chart.

', 'refs' => [ 'SingleAxisOptions$YAxisOptions' => '

The Y axis options of a single axis configuration.

', ], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountCustomizationRequest$Resolved' => '

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.

', ], ], ],]; diff --git a/src/data/states/2016-11-23/api-2.json b/src/data/states/2016-11-23/api-2.json index f96536dda9..58b6b5e169 100644 --- a/src/data/states/2016-11-23/api-2.json +++ b/src/data/states/2016-11-23/api-2.json @@ -2598,10 +2598,17 @@ "required":["definition"], "members":{ "definition":{"shape":"Definition"}, - "type":{"shape":"StateMachineType"} + "type":{"shape":"StateMachineType"}, + "severity":{"shape":"ValidateStateMachineDefinitionSeverity"}, + "maxResults":{"shape":"ValidateStateMachineDefinitionMaxResult"} } }, "ValidateStateMachineDefinitionLocation":{"type":"string"}, + "ValidateStateMachineDefinitionMaxResult":{ + "type":"integer", + "max":100, + "min":0 + }, "ValidateStateMachineDefinitionMessage":{"type":"string"}, "ValidateStateMachineDefinitionOutput":{ "type":"structure", @@ -2611,7 +2618,8 @@ ], "members":{ "result":{"shape":"ValidateStateMachineDefinitionResultCode"}, - "diagnostics":{"shape":"ValidateStateMachineDefinitionDiagnosticList"} + "diagnostics":{"shape":"ValidateStateMachineDefinitionDiagnosticList"}, + "truncated":{"shape":"ValidateStateMachineDefinitionTruncated"} } }, "ValidateStateMachineDefinitionResultCode":{ @@ -2623,7 +2631,14 @@ }, "ValidateStateMachineDefinitionSeverity":{ "type":"string", - "enum":["ERROR"] + "enum":[ + "ERROR", + "WARNING" + ] + }, + "ValidateStateMachineDefinitionTruncated":{ + "type":"boolean", + "box":true }, "ValidationException":{ "type":"structure", diff --git a/src/data/states/2016-11-23/api-2.json.php b/src/data/states/2016-11-23/api-2.json.php index a222532040..6fb85d1088 100644 --- a/src/data/states/2016-11-23/api-2.json.php +++ b/src/data/states/2016-11-23/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2016-11-23', 'endpointPrefix' => 'states', 'jsonVersion' => '1.0', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'AWS SFN', 'serviceFullName' => 'AWS Step Functions', 'serviceId' => 'SFN', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSStepFunctions', 'uid' => 'states-2016-11-23', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CreateActivity' => [ 'name' => 'CreateActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActivityInput', ], 'output' => [ 'shape' => 'CreateActivityOutput', ], 'errors' => [ [ 'shape' => 'ActivityLimitExceeded', ], [ 'shape' => 'ActivityAlreadyExists', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'TooManyTags', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'CreateStateMachine' => [ 'name' => 'CreateStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStateMachineInput', ], 'output' => [ 'shape' => 'CreateStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'InvalidLoggingConfiguration', ], [ 'shape' => 'InvalidTracingConfiguration', ], [ 'shape' => 'StateMachineAlreadyExists', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineLimitExceeded', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'TooManyTags', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'CreateStateMachineAlias' => [ 'name' => 'CreateStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStateMachineAliasInput', ], 'output' => [ 'shape' => 'CreateStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeleteActivity' => [ 'name' => 'DeleteActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActivityInput', ], 'output' => [ 'shape' => 'DeleteActivityOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], ], ], 'DeleteStateMachine' => [ 'name' => 'DeleteStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineInput', ], 'output' => [ 'shape' => 'DeleteStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteStateMachineAlias' => [ 'name' => 'DeleteStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineAliasInput', ], 'output' => [ 'shape' => 'DeleteStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteStateMachineVersion' => [ 'name' => 'DeleteStateMachineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineVersionInput', ], 'output' => [ 'shape' => 'DeleteStateMachineVersionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ConflictException', ], ], ], 'DescribeActivity' => [ 'name' => 'DescribeActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActivityInput', ], 'output' => [ 'shape' => 'DescribeActivityOutput', ], 'errors' => [ [ 'shape' => 'ActivityDoesNotExist', ], [ 'shape' => 'InvalidArn', ], ], ], 'DescribeExecution' => [ 'name' => 'DescribeExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExecutionInput', ], 'output' => [ 'shape' => 'DescribeExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'DescribeMapRun' => [ 'name' => 'DescribeMapRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMapRunInput', ], 'output' => [ 'shape' => 'DescribeMapRunOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'InvalidArn', ], ], ], 'DescribeStateMachine' => [ 'name' => 'DescribeStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineInput', ], 'output' => [ 'shape' => 'DescribeStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'DescribeStateMachineAlias' => [ 'name' => 'DescribeStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineAliasInput', ], 'output' => [ 'shape' => 'DescribeStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStateMachineForExecution' => [ 'name' => 'DescribeStateMachineForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineForExecutionInput', ], 'output' => [ 'shape' => 'DescribeStateMachineForExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'GetActivityTask' => [ 'name' => 'GetActivityTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActivityTaskInput', ], 'output' => [ 'shape' => 'GetActivityTaskOutput', ], 'errors' => [ [ 'shape' => 'ActivityDoesNotExist', ], [ 'shape' => 'ActivityWorkerLimitExceeded', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'GetExecutionHistory' => [ 'name' => 'GetExecutionHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExecutionHistoryInput', ], 'output' => [ 'shape' => 'GetExecutionHistoryOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'ListActivities' => [ 'name' => 'ListActivities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActivitiesInput', ], 'output' => [ 'shape' => 'ListActivitiesOutput', ], 'errors' => [ [ 'shape' => 'InvalidToken', ], ], ], 'ListExecutions' => [ 'name' => 'ListExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExecutionsInput', ], 'output' => [ 'shape' => 'ListExecutionsOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMapRuns' => [ 'name' => 'ListMapRuns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMapRunsInput', ], 'output' => [ 'shape' => 'ListMapRunsOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], ], ], 'ListStateMachineAliases' => [ 'name' => 'ListStateMachineAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachineAliasesInput', ], 'output' => [ 'shape' => 'ListStateMachineAliasesOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], ], ], 'ListStateMachineVersions' => [ 'name' => 'ListStateMachineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachineVersionsInput', ], 'output' => [ 'shape' => 'ListStateMachineVersionsOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], ], ], 'ListStateMachines' => [ 'name' => 'ListStateMachines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachinesInput', ], 'output' => [ 'shape' => 'ListStateMachinesOutput', ], 'errors' => [ [ 'shape' => 'InvalidToken', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceInput', ], 'output' => [ 'shape' => 'ListTagsForResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'PublishStateMachineVersion' => [ 'name' => 'PublishStateMachineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PublishStateMachineVersionInput', ], 'output' => [ 'shape' => 'PublishStateMachineVersionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidArn', ], ], 'idempotent' => true, ], 'RedriveExecution' => [ 'name' => 'RedriveExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RedriveExecutionInput', ], 'output' => [ 'shape' => 'RedriveExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'ExecutionNotRedrivable', ], [ 'shape' => 'ExecutionLimitExceeded', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], 'idempotent' => true, ], 'SendTaskFailure' => [ 'name' => 'SendTaskFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskFailureInput', ], 'output' => [ 'shape' => 'SendTaskFailureOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'SendTaskHeartbeat' => [ 'name' => 'SendTaskHeartbeat', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskHeartbeatInput', ], 'output' => [ 'shape' => 'SendTaskHeartbeatOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], ], ], 'SendTaskSuccess' => [ 'name' => 'SendTaskSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskSuccessInput', ], 'output' => [ 'shape' => 'SendTaskSuccessOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidOutput', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'StartExecution' => [ 'name' => 'StartExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExecutionInput', ], 'output' => [ 'shape' => 'StartExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionLimitExceeded', ], [ 'shape' => 'ExecutionAlreadyExists', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'StartSyncExecution' => [ 'name' => 'StartSyncExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartSyncExecutionInput', ], 'output' => [ 'shape' => 'StartSyncExecutionOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'endpoint' => [ 'hostPrefix' => 'sync-', ], ], 'StopExecution' => [ 'name' => 'StopExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopExecutionInput', ], 'output' => [ 'shape' => 'StopExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceInput', ], 'output' => [ 'shape' => 'TagResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'TooManyTags', ], ], ], 'TestState' => [ 'name' => 'TestState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestStateInput', ], 'output' => [ 'shape' => 'TestStateOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'ValidationException', ], ], 'endpoint' => [ 'hostPrefix' => 'sync-', ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceInput', ], 'output' => [ 'shape' => 'UntagResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMapRun' => [ 'name' => 'UpdateMapRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMapRunInput', ], 'output' => [ 'shape' => 'UpdateMapRunOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateStateMachine' => [ 'name' => 'UpdateStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStateMachineInput', ], 'output' => [ 'shape' => 'UpdateStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidLoggingConfiguration', ], [ 'shape' => 'InvalidTracingConfiguration', ], [ 'shape' => 'MissingRequiredParameter', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'UpdateStateMachineAlias' => [ 'name' => 'UpdateStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStateMachineAliasInput', ], 'output' => [ 'shape' => 'UpdateStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'StateMachineDeleting', ], ], ], 'ValidateStateMachineDefinition' => [ 'name' => 'ValidateStateMachineDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ValidateStateMachineDefinitionInput', ], 'output' => [ 'shape' => 'ValidateStateMachineDefinitionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'ActivityAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivityListItem', ], ], 'ActivityListItem' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'name', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'ActivityScheduleFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resource', ], 'members' => [ 'resource' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'heartbeatInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], ], ], 'ActivityStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'workerName' => [ 'shape' => 'Identity', ], ], ], 'ActivitySucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'ActivityTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityWorkerLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'AliasDescription' => [ 'type' => 'string', 'max' => 256, 'sensitive' => true, ], 'Arn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BilledDuration' => [ 'type' => 'long', 'min' => 0, ], 'BilledMemoryUsed' => [ 'type' => 'long', 'min' => 0, ], 'BillingDetails' => [ 'type' => 'structure', 'members' => [ 'billedMemoryUsedInMB' => [ 'shape' => 'BilledMemoryUsed', ], 'billedDurationInMilliseconds' => [ 'shape' => 'BilledDuration', ], ], ], 'CharacterRestrictedName' => [ 'type' => 'string', 'max' => 80, 'min' => 1, 'pattern' => '^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$', ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[!-~]+', ], 'CloudWatchEventsExecutionDataDetails' => [ 'type' => 'structure', 'members' => [ 'included' => [ 'shape' => 'includedDetails', ], ], ], 'CloudWatchLogsLogGroup' => [ 'type' => 'structure', 'members' => [ 'logGroupArn' => [ 'shape' => 'Arn', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConnectorParameters' => [ 'type' => 'string', 'max' => 262144, 'min' => 0, 'sensitive' => true, ], 'CreateActivityInput' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'tags' => [ 'shape' => 'TagList', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'CreateActivityOutput' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'CreateStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'name', 'routingConfiguration', ], 'members' => [ 'description' => [ 'shape' => 'AliasDescription', ], 'name' => [ 'shape' => 'CharacterRestrictedName', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], ], ], 'CreateStateMachineAliasOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', 'creationDate', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'CreateStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'name', 'definition', 'roleArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'type' => [ 'shape' => 'StateMachineType', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tags' => [ 'shape' => 'TagList', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'publish' => [ 'shape' => 'Publish', ], 'versionDescription' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'CreateStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'Definition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'sensitive' => true, ], 'DeleteActivityInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteActivityOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteStateMachineAliasOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteStateMachineOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineVersionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'LongArn', ], ], ], 'DeleteStateMachineVersionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeActivityInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeActivityOutput' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'name', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'DescribeExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'stateMachineArn', 'status', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], 'redriveDate' => [ 'shape' => 'Timestamp', ], 'redriveStatus' => [ 'shape' => 'ExecutionRedriveStatus', ], 'redriveStatusReason' => [ 'shape' => 'SensitiveData', ], ], ], 'DescribeMapRunInput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], ], ], 'DescribeMapRunOutput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', 'executionArn', 'status', 'startDate', 'maxConcurrency', 'toleratedFailurePercentage', 'toleratedFailureCount', 'itemCounts', 'executionCounts', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'executionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'MapRunStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'maxConcurrency' => [ 'shape' => 'MaxConcurrency', ], 'toleratedFailurePercentage' => [ 'shape' => 'ToleratedFailurePercentage', ], 'toleratedFailureCount' => [ 'shape' => 'ToleratedFailureCount', ], 'itemCounts' => [ 'shape' => 'MapRunItemCounts', ], 'executionCounts' => [ 'shape' => 'MapRunExecutionCounts', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeStateMachineAliasOutput' => [ 'type' => 'structure', 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'AliasDescription', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'updateDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeStateMachineForExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeStateMachineForExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'definition', 'roleArn', 'updateDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'updateDate' => [ 'shape' => 'Timestamp', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'label' => [ 'shape' => 'MapRunLabel', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'DescribeStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'definition', 'roleArn', 'type', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'StateMachineStatus', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'type' => [ 'shape' => 'StateMachineType', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'label' => [ 'shape' => 'MapRunLabel', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'description' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'Enabled' => [ 'type' => 'boolean', ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'kmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'kmsDataKeyReusePeriodSeconds' => [ 'shape' => 'KmsDataKeyReusePeriodSeconds', 'box' => true, ], 'type' => [ 'shape' => 'EncryptionType', ], ], ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'AWS_OWNED_KEY', 'CUSTOMER_MANAGED_KMS_KEY', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EventId' => [ 'type' => 'long', ], 'ExecutionAbortedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ExecutionAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ExecutionLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionListItem', ], ], 'ExecutionListItem' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'stateMachineArn', 'name', 'status', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'itemCount' => [ 'shape' => 'UnsignedInteger', 'box' => true, ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', 'box' => true, ], 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'ExecutionNotRedrivable' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionRedriveFilter' => [ 'type' => 'string', 'enum' => [ 'REDRIVEN', 'NOT_REDRIVEN', ], ], 'ExecutionRedriveStatus' => [ 'type' => 'string', 'enum' => [ 'REDRIVABLE', 'NOT_REDRIVABLE', 'REDRIVABLE_BY_MAP_RUN', ], ], 'ExecutionRedrivenEventDetails' => [ 'type' => 'structure', 'members' => [ 'redriveCount' => [ 'shape' => 'RedriveCount', ], ], ], 'ExecutionStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'roleArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'SUCCEEDED', 'FAILED', 'TIMED_OUT', 'ABORTED', 'PENDING_REDRIVE', ], ], 'ExecutionSucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'ExecutionTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'GetActivityTaskInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'workerName' => [ 'shape' => 'Name', ], ], ], 'GetActivityTaskOutput' => [ 'type' => 'structure', 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'input' => [ 'shape' => 'SensitiveDataJobInput', ], ], ], 'GetExecutionHistoryInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'reverseOrder' => [ 'shape' => 'ReverseOrder', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'includeExecutionData' => [ 'shape' => 'IncludeExecutionDataGetExecutionHistory', ], ], ], 'GetExecutionHistoryOutput' => [ 'type' => 'structure', 'required' => [ 'events', ], 'members' => [ 'events' => [ 'shape' => 'HistoryEventList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'HTTPBody' => [ 'type' => 'string', ], 'HTTPHeaders' => [ 'type' => 'string', ], 'HTTPMethod' => [ 'type' => 'string', ], 'HTTPProtocol' => [ 'type' => 'string', ], 'HTTPStatusCode' => [ 'type' => 'string', ], 'HTTPStatusMessage' => [ 'type' => 'string', ], 'HistoryEvent' => [ 'type' => 'structure', 'required' => [ 'timestamp', 'type', 'id', ], 'members' => [ 'timestamp' => [ 'shape' => 'Timestamp', ], 'type' => [ 'shape' => 'HistoryEventType', ], 'id' => [ 'shape' => 'EventId', ], 'previousEventId' => [ 'shape' => 'EventId', ], 'activityFailedEventDetails' => [ 'shape' => 'ActivityFailedEventDetails', ], 'activityScheduleFailedEventDetails' => [ 'shape' => 'ActivityScheduleFailedEventDetails', ], 'activityScheduledEventDetails' => [ 'shape' => 'ActivityScheduledEventDetails', ], 'activityStartedEventDetails' => [ 'shape' => 'ActivityStartedEventDetails', ], 'activitySucceededEventDetails' => [ 'shape' => 'ActivitySucceededEventDetails', ], 'activityTimedOutEventDetails' => [ 'shape' => 'ActivityTimedOutEventDetails', ], 'taskFailedEventDetails' => [ 'shape' => 'TaskFailedEventDetails', ], 'taskScheduledEventDetails' => [ 'shape' => 'TaskScheduledEventDetails', ], 'taskStartFailedEventDetails' => [ 'shape' => 'TaskStartFailedEventDetails', ], 'taskStartedEventDetails' => [ 'shape' => 'TaskStartedEventDetails', ], 'taskSubmitFailedEventDetails' => [ 'shape' => 'TaskSubmitFailedEventDetails', ], 'taskSubmittedEventDetails' => [ 'shape' => 'TaskSubmittedEventDetails', ], 'taskSucceededEventDetails' => [ 'shape' => 'TaskSucceededEventDetails', ], 'taskTimedOutEventDetails' => [ 'shape' => 'TaskTimedOutEventDetails', ], 'executionFailedEventDetails' => [ 'shape' => 'ExecutionFailedEventDetails', ], 'executionStartedEventDetails' => [ 'shape' => 'ExecutionStartedEventDetails', ], 'executionSucceededEventDetails' => [ 'shape' => 'ExecutionSucceededEventDetails', ], 'executionAbortedEventDetails' => [ 'shape' => 'ExecutionAbortedEventDetails', ], 'executionTimedOutEventDetails' => [ 'shape' => 'ExecutionTimedOutEventDetails', ], 'executionRedrivenEventDetails' => [ 'shape' => 'ExecutionRedrivenEventDetails', ], 'mapStateStartedEventDetails' => [ 'shape' => 'MapStateStartedEventDetails', ], 'mapIterationStartedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationSucceededEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationFailedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationAbortedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'lambdaFunctionFailedEventDetails' => [ 'shape' => 'LambdaFunctionFailedEventDetails', ], 'lambdaFunctionScheduleFailedEventDetails' => [ 'shape' => 'LambdaFunctionScheduleFailedEventDetails', ], 'lambdaFunctionScheduledEventDetails' => [ 'shape' => 'LambdaFunctionScheduledEventDetails', ], 'lambdaFunctionStartFailedEventDetails' => [ 'shape' => 'LambdaFunctionStartFailedEventDetails', ], 'lambdaFunctionSucceededEventDetails' => [ 'shape' => 'LambdaFunctionSucceededEventDetails', ], 'lambdaFunctionTimedOutEventDetails' => [ 'shape' => 'LambdaFunctionTimedOutEventDetails', ], 'stateEnteredEventDetails' => [ 'shape' => 'StateEnteredEventDetails', ], 'stateExitedEventDetails' => [ 'shape' => 'StateExitedEventDetails', ], 'mapRunStartedEventDetails' => [ 'shape' => 'MapRunStartedEventDetails', ], 'mapRunFailedEventDetails' => [ 'shape' => 'MapRunFailedEventDetails', ], 'mapRunRedrivenEventDetails' => [ 'shape' => 'MapRunRedrivenEventDetails', ], ], ], 'HistoryEventExecutionDataDetails' => [ 'type' => 'structure', 'members' => [ 'truncated' => [ 'shape' => 'truncated', ], ], ], 'HistoryEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoryEvent', ], ], 'HistoryEventType' => [ 'type' => 'string', 'enum' => [ 'ActivityFailed', 'ActivityScheduled', 'ActivityScheduleFailed', 'ActivityStarted', 'ActivitySucceeded', 'ActivityTimedOut', 'ChoiceStateEntered', 'ChoiceStateExited', 'ExecutionAborted', 'ExecutionFailed', 'ExecutionStarted', 'ExecutionSucceeded', 'ExecutionTimedOut', 'FailStateEntered', 'LambdaFunctionFailed', 'LambdaFunctionScheduled', 'LambdaFunctionScheduleFailed', 'LambdaFunctionStarted', 'LambdaFunctionStartFailed', 'LambdaFunctionSucceeded', 'LambdaFunctionTimedOut', 'MapIterationAborted', 'MapIterationFailed', 'MapIterationStarted', 'MapIterationSucceeded', 'MapStateAborted', 'MapStateEntered', 'MapStateExited', 'MapStateFailed', 'MapStateStarted', 'MapStateSucceeded', 'ParallelStateAborted', 'ParallelStateEntered', 'ParallelStateExited', 'ParallelStateFailed', 'ParallelStateStarted', 'ParallelStateSucceeded', 'PassStateEntered', 'PassStateExited', 'SucceedStateEntered', 'SucceedStateExited', 'TaskFailed', 'TaskScheduled', 'TaskStarted', 'TaskStartFailed', 'TaskStateAborted', 'TaskStateEntered', 'TaskStateExited', 'TaskSubmitFailed', 'TaskSubmitted', 'TaskSucceeded', 'TaskTimedOut', 'WaitStateAborted', 'WaitStateEntered', 'WaitStateExited', 'MapRunAborted', 'MapRunFailed', 'MapRunStarted', 'MapRunSucceeded', 'ExecutionRedriven', 'MapRunRedriven', ], ], 'Identity' => [ 'type' => 'string', 'max' => 256, ], 'IncludeExecutionData' => [ 'type' => 'boolean', ], 'IncludeExecutionDataGetExecutionHistory' => [ 'type' => 'boolean', 'box' => true, ], 'IncludedData' => [ 'type' => 'string', 'enum' => [ 'ALL_DATA', 'METADATA_ONLY', ], ], 'InspectionData' => [ 'type' => 'structure', 'members' => [ 'input' => [ 'shape' => 'SensitiveData', ], 'afterInputPath' => [ 'shape' => 'SensitiveData', ], 'afterParameters' => [ 'shape' => 'SensitiveData', ], 'result' => [ 'shape' => 'SensitiveData', ], 'afterResultSelector' => [ 'shape' => 'SensitiveData', ], 'afterResultPath' => [ 'shape' => 'SensitiveData', ], 'request' => [ 'shape' => 'InspectionDataRequest', ], 'response' => [ 'shape' => 'InspectionDataResponse', ], ], 'sensitive' => true, ], 'InspectionDataRequest' => [ 'type' => 'structure', 'members' => [ 'protocol' => [ 'shape' => 'HTTPProtocol', ], 'method' => [ 'shape' => 'HTTPMethod', ], 'url' => [ 'shape' => 'URL', ], 'headers' => [ 'shape' => 'HTTPHeaders', ], 'body' => [ 'shape' => 'HTTPBody', ], ], ], 'InspectionDataResponse' => [ 'type' => 'structure', 'members' => [ 'protocol' => [ 'shape' => 'HTTPProtocol', ], 'statusCode' => [ 'shape' => 'HTTPStatusCode', ], 'statusMessage' => [ 'shape' => 'HTTPStatusMessage', ], 'headers' => [ 'shape' => 'HTTPHeaders', ], 'body' => [ 'shape' => 'HTTPBody', ], ], ], 'InspectionLevel' => [ 'type' => 'string', 'enum' => [ 'INFO', 'DEBUG', 'TRACE', ], ], 'InvalidArn' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidDefinition' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidEncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidExecutionInput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidLoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidName' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidOutput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidToken' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidTracingConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsAccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsDataKeyReusePeriodSeconds' => [ 'type' => 'integer', 'box' => true, 'max' => 900, 'min' => 60, ], 'KmsInvalidStateException' => [ 'type' => 'structure', 'members' => [ 'kmsKeyState' => [ 'shape' => 'KmsKeyState', ], 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'KmsKeyState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'PENDING_DELETION', 'PENDING_IMPORT', 'UNAVAILABLE', 'CREATING', ], ], 'KmsThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'LambdaFunctionFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionScheduleFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resource', ], 'members' => [ 'resource' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'taskCredentials' => [ 'shape' => 'TaskCredentials', ], ], ], 'LambdaFunctionStartFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionSucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'LambdaFunctionTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ListActivitiesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListActivitiesOutput' => [ 'type' => 'structure', 'required' => [ 'activities', ], 'members' => [ 'activities' => [ 'shape' => 'ActivityList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListExecutionsInput' => [ 'type' => 'structure', 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'statusFilter' => [ 'shape' => 'ExecutionStatus', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'ListExecutionsPageToken', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'redriveFilter' => [ 'shape' => 'ExecutionRedriveFilter', ], ], ], 'ListExecutionsOutput' => [ 'type' => 'structure', 'required' => [ 'executions', ], 'members' => [ 'executions' => [ 'shape' => 'ExecutionList', ], 'nextToken' => [ 'shape' => 'ListExecutionsPageToken', ], ], ], 'ListExecutionsPageToken' => [ 'type' => 'string', 'max' => 3096, 'min' => 1, ], 'ListMapRunsInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListMapRunsOutput' => [ 'type' => 'structure', 'required' => [ 'mapRuns', ], 'members' => [ 'mapRuns' => [ 'shape' => 'MapRunList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachineAliasesInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'maxResults' => [ 'shape' => 'PageSize', ], ], ], 'ListStateMachineAliasesOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliases', ], 'members' => [ 'stateMachineAliases' => [ 'shape' => 'StateMachineAliasList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachineVersionsInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'maxResults' => [ 'shape' => 'PageSize', ], ], ], 'ListStateMachineVersionsOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersions', ], 'members' => [ 'stateMachineVersions' => [ 'shape' => 'StateMachineVersionList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachinesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachinesOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachines', ], 'members' => [ 'stateMachines' => [ 'shape' => 'StateMachineList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], ], ], 'ListTagsForResourceOutput' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagList', ], ], ], 'LogDestination' => [ 'type' => 'structure', 'members' => [ 'cloudWatchLogsLogGroup' => [ 'shape' => 'CloudWatchLogsLogGroup', ], ], ], 'LogDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDestination', ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'ALL', 'ERROR', 'FATAL', 'OFF', ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'level' => [ 'shape' => 'LogLevel', ], 'includeExecutionData' => [ 'shape' => 'IncludeExecutionData', ], 'destinations' => [ 'shape' => 'LogDestinationList', ], ], ], 'LongArn' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'LongObject' => [ 'type' => 'long', ], 'MapIterationEventDetails' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'index' => [ 'shape' => 'UnsignedInteger', ], ], ], 'MapRunExecutionCounts' => [ 'type' => 'structure', 'required' => [ 'pending', 'running', 'succeeded', 'failed', 'timedOut', 'aborted', 'total', 'resultsWritten', ], 'members' => [ 'pending' => [ 'shape' => 'UnsignedLong', ], 'running' => [ 'shape' => 'UnsignedLong', ], 'succeeded' => [ 'shape' => 'UnsignedLong', ], 'failed' => [ 'shape' => 'UnsignedLong', ], 'timedOut' => [ 'shape' => 'UnsignedLong', ], 'aborted' => [ 'shape' => 'UnsignedLong', ], 'total' => [ 'shape' => 'UnsignedLong', ], 'resultsWritten' => [ 'shape' => 'UnsignedLong', ], 'failuresNotRedrivable' => [ 'shape' => 'LongObject', ], 'pendingRedrive' => [ 'shape' => 'LongObject', ], ], ], 'MapRunFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'MapRunItemCounts' => [ 'type' => 'structure', 'required' => [ 'pending', 'running', 'succeeded', 'failed', 'timedOut', 'aborted', 'total', 'resultsWritten', ], 'members' => [ 'pending' => [ 'shape' => 'UnsignedLong', ], 'running' => [ 'shape' => 'UnsignedLong', ], 'succeeded' => [ 'shape' => 'UnsignedLong', ], 'failed' => [ 'shape' => 'UnsignedLong', ], 'timedOut' => [ 'shape' => 'UnsignedLong', ], 'aborted' => [ 'shape' => 'UnsignedLong', ], 'total' => [ 'shape' => 'UnsignedLong', ], 'resultsWritten' => [ 'shape' => 'UnsignedLong', ], 'failuresNotRedrivable' => [ 'shape' => 'LongObject', ], 'pendingRedrive' => [ 'shape' => 'LongObject', ], ], ], 'MapRunLabel' => [ 'type' => 'string', ], 'MapRunList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MapRunListItem', ], ], 'MapRunListItem' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'mapRunArn', 'stateMachineArn', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], ], ], 'MapRunRedrivenEventDetails' => [ 'type' => 'structure', 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], ], ], 'MapRunStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], ], ], 'MapRunStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'SUCCEEDED', 'FAILED', 'ABORTED', ], ], 'MapStateStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'length' => [ 'shape' => 'UnsignedInteger', ], ], ], 'MaxConcurrency' => [ 'type' => 'integer', 'min' => 0, ], 'MissingRequiredParameter' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Name' => [ 'type' => 'string', 'max' => 80, 'min' => 1, ], 'PageSize' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'PageToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'Publish' => [ 'type' => 'boolean', ], 'PublishStateMachineVersionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'description' => [ 'shape' => 'VersionDescription', ], ], ], 'PublishStateMachineVersionOutput' => [ 'type' => 'structure', 'required' => [ 'creationDate', 'stateMachineVersionArn', ], 'members' => [ 'creationDate' => [ 'shape' => 'Timestamp', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'RedriveCount' => [ 'type' => 'integer', 'box' => true, ], 'RedriveExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RedriveExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'redriveDate', ], 'members' => [ 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceName' => [ 'shape' => 'Arn', ], ], 'exception' => true, ], 'RevealSecrets' => [ 'type' => 'boolean', ], 'ReverseOrder' => [ 'type' => 'boolean', ], 'RevisionId' => [ 'type' => 'string', ], 'RoutingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingConfigurationListItem', ], 'max' => 2, 'min' => 1, ], 'RoutingConfigurationListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', 'weight', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'weight' => [ 'shape' => 'VersionWeight', ], ], ], 'SendTaskFailureInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'SendTaskFailureOutput' => [ 'type' => 'structure', 'members' => [], ], 'SendTaskHeartbeatInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], ], ], 'SendTaskHeartbeatOutput' => [ 'type' => 'structure', 'members' => [], ], 'SendTaskSuccessInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', 'output', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'output' => [ 'shape' => 'SensitiveData', ], ], ], 'SendTaskSuccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'SensitiveCause' => [ 'type' => 'string', 'max' => 32768, 'min' => 0, 'sensitive' => true, ], 'SensitiveData' => [ 'type' => 'string', 'max' => 262144, 'sensitive' => true, ], 'SensitiveDataJobInput' => [ 'type' => 'string', 'max' => 262144, 'sensitive' => true, ], 'SensitiveError' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'sensitive' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StartExecutionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], ], ], 'StartExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'startDate' => [ 'shape' => 'Timestamp', ], ], ], 'StartSyncExecutionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'StartSyncExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'startDate', 'stopDate', 'status', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'SyncExecutionStatus', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'billingDetails' => [ 'shape' => 'BillingDetails', ], ], ], 'StateEnteredEventDetails' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'StateExitedEventDetails' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'StateMachineAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineAliasListItem', ], ], 'StateMachineAliasListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', 'creationDate', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'LongArn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateMachineAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineDeleting' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineListItem', ], ], 'StateMachineListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'type', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'StateMachineType', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateMachineStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', ], ], 'StateMachineType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'EXPRESS', ], ], 'StateMachineTypeNotSupported' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineVersionListItem', ], ], 'StateMachineVersionListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', 'creationDate', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'LongArn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateName' => [ 'type' => 'string', 'max' => 80, 'min' => 1, ], 'StopExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'StopExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'stopDate', ], 'members' => [ 'stopDate' => [ 'shape' => 'Timestamp', ], ], ], 'SyncExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'TIMED_OUT', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TaskCredentials' => [ 'type' => 'structure', 'members' => [ 'roleArn' => [ 'shape' => 'LongArn', ], ], ], 'TaskDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TaskFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', 'region', 'parameters', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'region' => [ 'shape' => 'Name', ], 'parameters' => [ 'shape' => 'ConnectorParameters', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'heartbeatInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'taskCredentials' => [ 'shape' => 'TaskCredentials', ], ], ], 'TaskStartFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskStartedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], ], ], 'TaskSubmitFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskSubmittedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'TaskSucceededEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'TaskTimedOut' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TaskTimedOutEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TestExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'RETRIABLE', 'CAUGHT_ERROR', ], ], 'TestStateInput' => [ 'type' => 'structure', 'required' => [ 'definition', 'roleArn', ], 'members' => [ 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inspectionLevel' => [ 'shape' => 'InspectionLevel', ], 'revealSecrets' => [ 'shape' => 'RevealSecrets', ], ], ], 'TestStateOutput' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'inspectionData' => [ 'shape' => 'InspectionData', ], 'nextState' => [ 'shape' => 'StateName', ], 'status' => [ 'shape' => 'TestExecutionStatus', ], ], ], 'TimeoutInSeconds' => [ 'type' => 'long', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'ToleratedFailureCount' => [ 'type' => 'long', 'min' => 0, ], 'ToleratedFailurePercentage' => [ 'type' => 'float', 'max' => 100, 'min' => 0, ], 'TooManyTags' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceName' => [ 'shape' => 'Arn', ], ], 'exception' => true, ], 'TraceHeader' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\p{ASCII}*', ], 'TracingConfiguration' => [ 'type' => 'structure', 'members' => [ 'enabled' => [ 'shape' => 'Enabled', ], ], ], 'URL' => [ 'type' => 'string', ], 'UnsignedInteger' => [ 'type' => 'integer', 'min' => 0, ], 'UnsignedLong' => [ 'type' => 'long', 'min' => 0, ], 'UntagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMapRunInput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'maxConcurrency' => [ 'shape' => 'MaxConcurrency', 'box' => true, ], 'toleratedFailurePercentage' => [ 'shape' => 'ToleratedFailurePercentage', 'box' => true, ], 'toleratedFailureCount' => [ 'shape' => 'ToleratedFailureCount', 'box' => true, ], ], ], 'UpdateMapRunOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'AliasDescription', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], ], ], 'UpdateStateMachineAliasOutput' => [ 'type' => 'structure', 'required' => [ 'updateDate', ], 'members' => [ 'updateDate' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'publish' => [ 'shape' => 'Publish', ], 'versionDescription' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'UpdateStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'updateDate', ], 'members' => [ 'updateDate' => [ 'shape' => 'Timestamp', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'ValidateStateMachineDefinitionCode' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionDiagnostic' => [ 'type' => 'structure', 'required' => [ 'severity', 'code', 'message', ], 'members' => [ 'severity' => [ 'shape' => 'ValidateStateMachineDefinitionSeverity', ], 'code' => [ 'shape' => 'ValidateStateMachineDefinitionCode', ], 'message' => [ 'shape' => 'ValidateStateMachineDefinitionMessage', ], 'location' => [ 'shape' => 'ValidateStateMachineDefinitionLocation', ], ], ], 'ValidateStateMachineDefinitionDiagnosticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidateStateMachineDefinitionDiagnostic', ], ], 'ValidateStateMachineDefinitionInput' => [ 'type' => 'structure', 'required' => [ 'definition', ], 'members' => [ 'definition' => [ 'shape' => 'Definition', ], 'type' => [ 'shape' => 'StateMachineType', ], ], ], 'ValidateStateMachineDefinitionLocation' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionMessage' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionOutput' => [ 'type' => 'structure', 'required' => [ 'result', 'diagnostics', ], 'members' => [ 'result' => [ 'shape' => 'ValidateStateMachineDefinitionResultCode', ], 'diagnostics' => [ 'shape' => 'ValidateStateMachineDefinitionDiagnosticList', ], ], ], 'ValidateStateMachineDefinitionResultCode' => [ 'type' => 'string', 'enum' => [ 'OK', 'FAIL', ], ], 'ValidateStateMachineDefinitionSeverity' => [ 'type' => 'string', 'enum' => [ 'ERROR', ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'exception' => true, ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'API_DOES_NOT_SUPPORT_LABELED_ARNS', 'MISSING_REQUIRED_PARAMETER', 'CANNOT_UPDATE_COMPLETED_MAP_RUN', 'INVALID_ROUTING_CONFIGURATION', ], ], 'VersionDescription' => [ 'type' => 'string', 'max' => 256, 'sensitive' => true, ], 'VersionWeight' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'includedDetails' => [ 'type' => 'boolean', ], 'truncated' => [ 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2016-11-23', 'endpointPrefix' => 'states', 'jsonVersion' => '1.0', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'AWS SFN', 'serviceFullName' => 'AWS Step Functions', 'serviceId' => 'SFN', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSStepFunctions', 'uid' => 'states-2016-11-23', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CreateActivity' => [ 'name' => 'CreateActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActivityInput', ], 'output' => [ 'shape' => 'CreateActivityOutput', ], 'errors' => [ [ 'shape' => 'ActivityLimitExceeded', ], [ 'shape' => 'ActivityAlreadyExists', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'TooManyTags', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'CreateStateMachine' => [ 'name' => 'CreateStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStateMachineInput', ], 'output' => [ 'shape' => 'CreateStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'InvalidLoggingConfiguration', ], [ 'shape' => 'InvalidTracingConfiguration', ], [ 'shape' => 'StateMachineAlreadyExists', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineLimitExceeded', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'TooManyTags', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'CreateStateMachineAlias' => [ 'name' => 'CreateStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStateMachineAliasInput', ], 'output' => [ 'shape' => 'CreateStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeleteActivity' => [ 'name' => 'DeleteActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActivityInput', ], 'output' => [ 'shape' => 'DeleteActivityOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], ], ], 'DeleteStateMachine' => [ 'name' => 'DeleteStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineInput', ], 'output' => [ 'shape' => 'DeleteStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteStateMachineAlias' => [ 'name' => 'DeleteStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineAliasInput', ], 'output' => [ 'shape' => 'DeleteStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteStateMachineVersion' => [ 'name' => 'DeleteStateMachineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStateMachineVersionInput', ], 'output' => [ 'shape' => 'DeleteStateMachineVersionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ConflictException', ], ], ], 'DescribeActivity' => [ 'name' => 'DescribeActivity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActivityInput', ], 'output' => [ 'shape' => 'DescribeActivityOutput', ], 'errors' => [ [ 'shape' => 'ActivityDoesNotExist', ], [ 'shape' => 'InvalidArn', ], ], ], 'DescribeExecution' => [ 'name' => 'DescribeExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExecutionInput', ], 'output' => [ 'shape' => 'DescribeExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'DescribeMapRun' => [ 'name' => 'DescribeMapRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMapRunInput', ], 'output' => [ 'shape' => 'DescribeMapRunOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'InvalidArn', ], ], ], 'DescribeStateMachine' => [ 'name' => 'DescribeStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineInput', ], 'output' => [ 'shape' => 'DescribeStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'DescribeStateMachineAlias' => [ 'name' => 'DescribeStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineAliasInput', ], 'output' => [ 'shape' => 'DescribeStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStateMachineForExecution' => [ 'name' => 'DescribeStateMachineForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStateMachineForExecutionInput', ], 'output' => [ 'shape' => 'DescribeStateMachineForExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'GetActivityTask' => [ 'name' => 'GetActivityTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActivityTaskInput', ], 'output' => [ 'shape' => 'GetActivityTaskOutput', ], 'errors' => [ [ 'shape' => 'ActivityDoesNotExist', ], [ 'shape' => 'ActivityWorkerLimitExceeded', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'GetExecutionHistory' => [ 'name' => 'GetExecutionHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExecutionHistoryInput', ], 'output' => [ 'shape' => 'GetExecutionHistoryOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'ListActivities' => [ 'name' => 'ListActivities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActivitiesInput', ], 'output' => [ 'shape' => 'ListActivitiesOutput', ], 'errors' => [ [ 'shape' => 'InvalidToken', ], ], ], 'ListExecutions' => [ 'name' => 'ListExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExecutionsInput', ], 'output' => [ 'shape' => 'ListExecutionsOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMapRuns' => [ 'name' => 'ListMapRuns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMapRunsInput', ], 'output' => [ 'shape' => 'ListMapRunsOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], ], ], 'ListStateMachineAliases' => [ 'name' => 'ListStateMachineAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachineAliasesInput', ], 'output' => [ 'shape' => 'ListStateMachineAliasesOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], ], ], 'ListStateMachineVersions' => [ 'name' => 'ListStateMachineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachineVersionsInput', ], 'output' => [ 'shape' => 'ListStateMachineVersionsOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidToken', ], ], ], 'ListStateMachines' => [ 'name' => 'ListStateMachines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStateMachinesInput', ], 'output' => [ 'shape' => 'ListStateMachinesOutput', ], 'errors' => [ [ 'shape' => 'InvalidToken', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceInput', ], 'output' => [ 'shape' => 'ListTagsForResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'PublishStateMachineVersion' => [ 'name' => 'PublishStateMachineVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PublishStateMachineVersionInput', ], 'output' => [ 'shape' => 'PublishStateMachineVersionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidArn', ], ], 'idempotent' => true, ], 'RedriveExecution' => [ 'name' => 'RedriveExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RedriveExecutionInput', ], 'output' => [ 'shape' => 'RedriveExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'ExecutionNotRedrivable', ], [ 'shape' => 'ExecutionLimitExceeded', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], 'idempotent' => true, ], 'SendTaskFailure' => [ 'name' => 'SendTaskFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskFailureInput', ], 'output' => [ 'shape' => 'SendTaskFailureOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'SendTaskHeartbeat' => [ 'name' => 'SendTaskHeartbeat', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskHeartbeatInput', ], 'output' => [ 'shape' => 'SendTaskHeartbeatOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], ], ], 'SendTaskSuccess' => [ 'name' => 'SendTaskSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendTaskSuccessInput', ], 'output' => [ 'shape' => 'SendTaskSuccessOutput', ], 'errors' => [ [ 'shape' => 'TaskDoesNotExist', ], [ 'shape' => 'InvalidOutput', ], [ 'shape' => 'InvalidToken', ], [ 'shape' => 'TaskTimedOut', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'StartExecution' => [ 'name' => 'StartExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExecutionInput', ], 'output' => [ 'shape' => 'StartExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionLimitExceeded', ], [ 'shape' => 'ExecutionAlreadyExists', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'StartSyncExecution' => [ 'name' => 'StartSyncExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartSyncExecutionInput', ], 'output' => [ 'shape' => 'StartSyncExecutionOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'InvalidName', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineTypeNotSupported', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'endpoint' => [ 'hostPrefix' => 'sync-', ], ], 'StopExecution' => [ 'name' => 'StopExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopExecutionInput', ], 'output' => [ 'shape' => 'StopExecutionOutput', ], 'errors' => [ [ 'shape' => 'ExecutionDoesNotExist', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsInvalidStateException', ], [ 'shape' => 'KmsThrottlingException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceInput', ], 'output' => [ 'shape' => 'TagResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'TooManyTags', ], ], ], 'TestState' => [ 'name' => 'TestState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestStateInput', ], 'output' => [ 'shape' => 'TestStateOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidExecutionInput', ], [ 'shape' => 'ValidationException', ], ], 'endpoint' => [ 'hostPrefix' => 'sync-', ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceInput', ], 'output' => [ 'shape' => 'UntagResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMapRun' => [ 'name' => 'UpdateMapRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMapRunInput', ], 'output' => [ 'shape' => 'UpdateMapRunOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateStateMachine' => [ 'name' => 'UpdateStateMachine', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStateMachineInput', ], 'output' => [ 'shape' => 'UpdateStateMachineOutput', ], 'errors' => [ [ 'shape' => 'InvalidArn', ], [ 'shape' => 'InvalidDefinition', ], [ 'shape' => 'InvalidLoggingConfiguration', ], [ 'shape' => 'InvalidTracingConfiguration', ], [ 'shape' => 'MissingRequiredParameter', ], [ 'shape' => 'StateMachineDeleting', ], [ 'shape' => 'StateMachineDoesNotExist', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidEncryptionConfiguration', ], [ 'shape' => 'KmsAccessDeniedException', ], [ 'shape' => 'KmsThrottlingException', ], ], 'idempotent' => true, ], 'UpdateStateMachineAlias' => [ 'name' => 'UpdateStateMachineAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStateMachineAliasInput', ], 'output' => [ 'shape' => 'UpdateStateMachineAliasOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidArn', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'StateMachineDeleting', ], ], ], 'ValidateStateMachineDefinition' => [ 'name' => 'ValidateStateMachineDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ValidateStateMachineDefinitionInput', ], 'output' => [ 'shape' => 'ValidateStateMachineDefinitionOutput', ], 'errors' => [ [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'ActivityAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ActivityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActivityListItem', ], ], 'ActivityListItem' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'name', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'ActivityScheduleFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resource', ], 'members' => [ 'resource' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'heartbeatInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], ], ], 'ActivityStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'workerName' => [ 'shape' => 'Identity', ], ], ], 'ActivitySucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'ActivityTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ActivityWorkerLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'AliasDescription' => [ 'type' => 'string', 'max' => 256, 'sensitive' => true, ], 'Arn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BilledDuration' => [ 'type' => 'long', 'min' => 0, ], 'BilledMemoryUsed' => [ 'type' => 'long', 'min' => 0, ], 'BillingDetails' => [ 'type' => 'structure', 'members' => [ 'billedMemoryUsedInMB' => [ 'shape' => 'BilledMemoryUsed', ], 'billedDurationInMilliseconds' => [ 'shape' => 'BilledDuration', ], ], ], 'CharacterRestrictedName' => [ 'type' => 'string', 'max' => 80, 'min' => 1, 'pattern' => '^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$', ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[!-~]+', ], 'CloudWatchEventsExecutionDataDetails' => [ 'type' => 'structure', 'members' => [ 'included' => [ 'shape' => 'includedDetails', ], ], ], 'CloudWatchLogsLogGroup' => [ 'type' => 'structure', 'members' => [ 'logGroupArn' => [ 'shape' => 'Arn', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConnectorParameters' => [ 'type' => 'string', 'max' => 262144, 'min' => 0, 'sensitive' => true, ], 'CreateActivityInput' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'tags' => [ 'shape' => 'TagList', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'CreateActivityOutput' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'CreateStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'name', 'routingConfiguration', ], 'members' => [ 'description' => [ 'shape' => 'AliasDescription', ], 'name' => [ 'shape' => 'CharacterRestrictedName', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], ], ], 'CreateStateMachineAliasOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', 'creationDate', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'CreateStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'name', 'definition', 'roleArn', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'type' => [ 'shape' => 'StateMachineType', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tags' => [ 'shape' => 'TagList', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'publish' => [ 'shape' => 'Publish', ], 'versionDescription' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'CreateStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'Definition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'sensitive' => true, ], 'DeleteActivityInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteActivityOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteStateMachineAliasOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], ], ], 'DeleteStateMachineOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStateMachineVersionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'LongArn', ], ], ], 'DeleteStateMachineVersionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeActivityInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeActivityOutput' => [ 'type' => 'structure', 'required' => [ 'activityArn', 'name', 'creationDate', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'DescribeExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'stateMachineArn', 'status', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], 'redriveDate' => [ 'shape' => 'Timestamp', ], 'redriveStatus' => [ 'shape' => 'ExecutionRedriveStatus', ], 'redriveStatusReason' => [ 'shape' => 'SensitiveData', ], ], ], 'DescribeMapRunInput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], ], ], 'DescribeMapRunOutput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', 'executionArn', 'status', 'startDate', 'maxConcurrency', 'toleratedFailurePercentage', 'toleratedFailureCount', 'itemCounts', 'executionCounts', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'executionArn' => [ 'shape' => 'Arn', ], 'status' => [ 'shape' => 'MapRunStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'maxConcurrency' => [ 'shape' => 'MaxConcurrency', ], 'toleratedFailurePercentage' => [ 'shape' => 'ToleratedFailurePercentage', ], 'toleratedFailureCount' => [ 'shape' => 'ToleratedFailureCount', ], 'itemCounts' => [ 'shape' => 'MapRunItemCounts', ], 'executionCounts' => [ 'shape' => 'MapRunExecutionCounts', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeStateMachineAliasOutput' => [ 'type' => 'structure', 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'AliasDescription', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'updateDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeStateMachineForExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeStateMachineForExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'definition', 'roleArn', 'updateDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'updateDate' => [ 'shape' => 'Timestamp', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'label' => [ 'shape' => 'MapRunLabel', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'DescribeStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'DescribeStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'definition', 'roleArn', 'type', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'StateMachineStatus', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'type' => [ 'shape' => 'StateMachineType', ], 'creationDate' => [ 'shape' => 'Timestamp', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'label' => [ 'shape' => 'MapRunLabel', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'description' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'Enabled' => [ 'type' => 'boolean', ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'kmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'kmsDataKeyReusePeriodSeconds' => [ 'shape' => 'KmsDataKeyReusePeriodSeconds', 'box' => true, ], 'type' => [ 'shape' => 'EncryptionType', ], ], ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'AWS_OWNED_KEY', 'CUSTOMER_MANAGED_KMS_KEY', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'EventId' => [ 'type' => 'long', ], 'ExecutionAbortedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ExecutionAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ExecutionLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionListItem', ], ], 'ExecutionListItem' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'stateMachineArn', 'name', 'status', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'itemCount' => [ 'shape' => 'UnsignedInteger', 'box' => true, ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', 'box' => true, ], 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'ExecutionNotRedrivable' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ExecutionRedriveFilter' => [ 'type' => 'string', 'enum' => [ 'REDRIVEN', 'NOT_REDRIVEN', ], ], 'ExecutionRedriveStatus' => [ 'type' => 'string', 'enum' => [ 'REDRIVABLE', 'NOT_REDRIVABLE', 'REDRIVABLE_BY_MAP_RUN', ], ], 'ExecutionRedrivenEventDetails' => [ 'type' => 'structure', 'members' => [ 'redriveCount' => [ 'shape' => 'RedriveCount', ], ], ], 'ExecutionStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'roleArn' => [ 'shape' => 'Arn', ], 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'SUCCEEDED', 'FAILED', 'TIMED_OUT', 'ABORTED', 'PENDING_REDRIVE', ], ], 'ExecutionSucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'ExecutionTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'GetActivityTaskInput' => [ 'type' => 'structure', 'required' => [ 'activityArn', ], 'members' => [ 'activityArn' => [ 'shape' => 'Arn', ], 'workerName' => [ 'shape' => 'Name', ], ], ], 'GetActivityTaskOutput' => [ 'type' => 'structure', 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'input' => [ 'shape' => 'SensitiveDataJobInput', ], ], ], 'GetExecutionHistoryInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'reverseOrder' => [ 'shape' => 'ReverseOrder', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'includeExecutionData' => [ 'shape' => 'IncludeExecutionDataGetExecutionHistory', ], ], ], 'GetExecutionHistoryOutput' => [ 'type' => 'structure', 'required' => [ 'events', ], 'members' => [ 'events' => [ 'shape' => 'HistoryEventList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'HTTPBody' => [ 'type' => 'string', ], 'HTTPHeaders' => [ 'type' => 'string', ], 'HTTPMethod' => [ 'type' => 'string', ], 'HTTPProtocol' => [ 'type' => 'string', ], 'HTTPStatusCode' => [ 'type' => 'string', ], 'HTTPStatusMessage' => [ 'type' => 'string', ], 'HistoryEvent' => [ 'type' => 'structure', 'required' => [ 'timestamp', 'type', 'id', ], 'members' => [ 'timestamp' => [ 'shape' => 'Timestamp', ], 'type' => [ 'shape' => 'HistoryEventType', ], 'id' => [ 'shape' => 'EventId', ], 'previousEventId' => [ 'shape' => 'EventId', ], 'activityFailedEventDetails' => [ 'shape' => 'ActivityFailedEventDetails', ], 'activityScheduleFailedEventDetails' => [ 'shape' => 'ActivityScheduleFailedEventDetails', ], 'activityScheduledEventDetails' => [ 'shape' => 'ActivityScheduledEventDetails', ], 'activityStartedEventDetails' => [ 'shape' => 'ActivityStartedEventDetails', ], 'activitySucceededEventDetails' => [ 'shape' => 'ActivitySucceededEventDetails', ], 'activityTimedOutEventDetails' => [ 'shape' => 'ActivityTimedOutEventDetails', ], 'taskFailedEventDetails' => [ 'shape' => 'TaskFailedEventDetails', ], 'taskScheduledEventDetails' => [ 'shape' => 'TaskScheduledEventDetails', ], 'taskStartFailedEventDetails' => [ 'shape' => 'TaskStartFailedEventDetails', ], 'taskStartedEventDetails' => [ 'shape' => 'TaskStartedEventDetails', ], 'taskSubmitFailedEventDetails' => [ 'shape' => 'TaskSubmitFailedEventDetails', ], 'taskSubmittedEventDetails' => [ 'shape' => 'TaskSubmittedEventDetails', ], 'taskSucceededEventDetails' => [ 'shape' => 'TaskSucceededEventDetails', ], 'taskTimedOutEventDetails' => [ 'shape' => 'TaskTimedOutEventDetails', ], 'executionFailedEventDetails' => [ 'shape' => 'ExecutionFailedEventDetails', ], 'executionStartedEventDetails' => [ 'shape' => 'ExecutionStartedEventDetails', ], 'executionSucceededEventDetails' => [ 'shape' => 'ExecutionSucceededEventDetails', ], 'executionAbortedEventDetails' => [ 'shape' => 'ExecutionAbortedEventDetails', ], 'executionTimedOutEventDetails' => [ 'shape' => 'ExecutionTimedOutEventDetails', ], 'executionRedrivenEventDetails' => [ 'shape' => 'ExecutionRedrivenEventDetails', ], 'mapStateStartedEventDetails' => [ 'shape' => 'MapStateStartedEventDetails', ], 'mapIterationStartedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationSucceededEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationFailedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'mapIterationAbortedEventDetails' => [ 'shape' => 'MapIterationEventDetails', ], 'lambdaFunctionFailedEventDetails' => [ 'shape' => 'LambdaFunctionFailedEventDetails', ], 'lambdaFunctionScheduleFailedEventDetails' => [ 'shape' => 'LambdaFunctionScheduleFailedEventDetails', ], 'lambdaFunctionScheduledEventDetails' => [ 'shape' => 'LambdaFunctionScheduledEventDetails', ], 'lambdaFunctionStartFailedEventDetails' => [ 'shape' => 'LambdaFunctionStartFailedEventDetails', ], 'lambdaFunctionSucceededEventDetails' => [ 'shape' => 'LambdaFunctionSucceededEventDetails', ], 'lambdaFunctionTimedOutEventDetails' => [ 'shape' => 'LambdaFunctionTimedOutEventDetails', ], 'stateEnteredEventDetails' => [ 'shape' => 'StateEnteredEventDetails', ], 'stateExitedEventDetails' => [ 'shape' => 'StateExitedEventDetails', ], 'mapRunStartedEventDetails' => [ 'shape' => 'MapRunStartedEventDetails', ], 'mapRunFailedEventDetails' => [ 'shape' => 'MapRunFailedEventDetails', ], 'mapRunRedrivenEventDetails' => [ 'shape' => 'MapRunRedrivenEventDetails', ], ], ], 'HistoryEventExecutionDataDetails' => [ 'type' => 'structure', 'members' => [ 'truncated' => [ 'shape' => 'truncated', ], ], ], 'HistoryEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoryEvent', ], ], 'HistoryEventType' => [ 'type' => 'string', 'enum' => [ 'ActivityFailed', 'ActivityScheduled', 'ActivityScheduleFailed', 'ActivityStarted', 'ActivitySucceeded', 'ActivityTimedOut', 'ChoiceStateEntered', 'ChoiceStateExited', 'ExecutionAborted', 'ExecutionFailed', 'ExecutionStarted', 'ExecutionSucceeded', 'ExecutionTimedOut', 'FailStateEntered', 'LambdaFunctionFailed', 'LambdaFunctionScheduled', 'LambdaFunctionScheduleFailed', 'LambdaFunctionStarted', 'LambdaFunctionStartFailed', 'LambdaFunctionSucceeded', 'LambdaFunctionTimedOut', 'MapIterationAborted', 'MapIterationFailed', 'MapIterationStarted', 'MapIterationSucceeded', 'MapStateAborted', 'MapStateEntered', 'MapStateExited', 'MapStateFailed', 'MapStateStarted', 'MapStateSucceeded', 'ParallelStateAborted', 'ParallelStateEntered', 'ParallelStateExited', 'ParallelStateFailed', 'ParallelStateStarted', 'ParallelStateSucceeded', 'PassStateEntered', 'PassStateExited', 'SucceedStateEntered', 'SucceedStateExited', 'TaskFailed', 'TaskScheduled', 'TaskStarted', 'TaskStartFailed', 'TaskStateAborted', 'TaskStateEntered', 'TaskStateExited', 'TaskSubmitFailed', 'TaskSubmitted', 'TaskSucceeded', 'TaskTimedOut', 'WaitStateAborted', 'WaitStateEntered', 'WaitStateExited', 'MapRunAborted', 'MapRunFailed', 'MapRunStarted', 'MapRunSucceeded', 'ExecutionRedriven', 'MapRunRedriven', ], ], 'Identity' => [ 'type' => 'string', 'max' => 256, ], 'IncludeExecutionData' => [ 'type' => 'boolean', ], 'IncludeExecutionDataGetExecutionHistory' => [ 'type' => 'boolean', 'box' => true, ], 'IncludedData' => [ 'type' => 'string', 'enum' => [ 'ALL_DATA', 'METADATA_ONLY', ], ], 'InspectionData' => [ 'type' => 'structure', 'members' => [ 'input' => [ 'shape' => 'SensitiveData', ], 'afterInputPath' => [ 'shape' => 'SensitiveData', ], 'afterParameters' => [ 'shape' => 'SensitiveData', ], 'result' => [ 'shape' => 'SensitiveData', ], 'afterResultSelector' => [ 'shape' => 'SensitiveData', ], 'afterResultPath' => [ 'shape' => 'SensitiveData', ], 'request' => [ 'shape' => 'InspectionDataRequest', ], 'response' => [ 'shape' => 'InspectionDataResponse', ], ], 'sensitive' => true, ], 'InspectionDataRequest' => [ 'type' => 'structure', 'members' => [ 'protocol' => [ 'shape' => 'HTTPProtocol', ], 'method' => [ 'shape' => 'HTTPMethod', ], 'url' => [ 'shape' => 'URL', ], 'headers' => [ 'shape' => 'HTTPHeaders', ], 'body' => [ 'shape' => 'HTTPBody', ], ], ], 'InspectionDataResponse' => [ 'type' => 'structure', 'members' => [ 'protocol' => [ 'shape' => 'HTTPProtocol', ], 'statusCode' => [ 'shape' => 'HTTPStatusCode', ], 'statusMessage' => [ 'shape' => 'HTTPStatusMessage', ], 'headers' => [ 'shape' => 'HTTPHeaders', ], 'body' => [ 'shape' => 'HTTPBody', ], ], ], 'InspectionLevel' => [ 'type' => 'string', 'enum' => [ 'INFO', 'DEBUG', 'TRACE', ], ], 'InvalidArn' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidDefinition' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidEncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidExecutionInput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidLoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidName' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidOutput' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidToken' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidTracingConfiguration' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsAccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsDataKeyReusePeriodSeconds' => [ 'type' => 'integer', 'box' => true, 'max' => 900, 'min' => 60, ], 'KmsInvalidStateException' => [ 'type' => 'structure', 'members' => [ 'kmsKeyState' => [ 'shape' => 'KmsKeyState', ], 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'KmsKeyState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'PENDING_DELETION', 'PENDING_IMPORT', 'UNAVAILABLE', 'CREATING', ], ], 'KmsThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'LambdaFunctionFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionScheduleFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resource', ], 'members' => [ 'resource' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'taskCredentials' => [ 'shape' => 'TaskCredentials', ], ], ], 'LambdaFunctionStartFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'LambdaFunctionSucceededEventDetails' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'LambdaFunctionTimedOutEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'ListActivitiesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListActivitiesOutput' => [ 'type' => 'structure', 'required' => [ 'activities', ], 'members' => [ 'activities' => [ 'shape' => 'ActivityList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListExecutionsInput' => [ 'type' => 'structure', 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'statusFilter' => [ 'shape' => 'ExecutionStatus', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'ListExecutionsPageToken', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'redriveFilter' => [ 'shape' => 'ExecutionRedriveFilter', ], ], ], 'ListExecutionsOutput' => [ 'type' => 'structure', 'required' => [ 'executions', ], 'members' => [ 'executions' => [ 'shape' => 'ExecutionList', ], 'nextToken' => [ 'shape' => 'ListExecutionsPageToken', ], ], ], 'ListExecutionsPageToken' => [ 'type' => 'string', 'max' => 3096, 'min' => 1, ], 'ListMapRunsInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListMapRunsOutput' => [ 'type' => 'structure', 'required' => [ 'mapRuns', ], 'members' => [ 'mapRuns' => [ 'shape' => 'MapRunList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachineAliasesInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'maxResults' => [ 'shape' => 'PageSize', ], ], ], 'ListStateMachineAliasesOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliases', ], 'members' => [ 'stateMachineAliases' => [ 'shape' => 'StateMachineAliasList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachineVersionsInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'nextToken' => [ 'shape' => 'PageToken', ], 'maxResults' => [ 'shape' => 'PageSize', ], ], ], 'ListStateMachineVersionsOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersions', ], 'members' => [ 'stateMachineVersions' => [ 'shape' => 'StateMachineVersionList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachinesInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'PageSize', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStateMachinesOutput' => [ 'type' => 'structure', 'required' => [ 'stateMachines', ], 'members' => [ 'stateMachines' => [ 'shape' => 'StateMachineList', ], 'nextToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], ], ], 'ListTagsForResourceOutput' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagList', ], ], ], 'LogDestination' => [ 'type' => 'structure', 'members' => [ 'cloudWatchLogsLogGroup' => [ 'shape' => 'CloudWatchLogsLogGroup', ], ], ], 'LogDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDestination', ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'ALL', 'ERROR', 'FATAL', 'OFF', ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'members' => [ 'level' => [ 'shape' => 'LogLevel', ], 'includeExecutionData' => [ 'shape' => 'IncludeExecutionData', ], 'destinations' => [ 'shape' => 'LogDestinationList', ], ], ], 'LongArn' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'LongObject' => [ 'type' => 'long', ], 'MapIterationEventDetails' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'Name', ], 'index' => [ 'shape' => 'UnsignedInteger', ], ], ], 'MapRunExecutionCounts' => [ 'type' => 'structure', 'required' => [ 'pending', 'running', 'succeeded', 'failed', 'timedOut', 'aborted', 'total', 'resultsWritten', ], 'members' => [ 'pending' => [ 'shape' => 'UnsignedLong', ], 'running' => [ 'shape' => 'UnsignedLong', ], 'succeeded' => [ 'shape' => 'UnsignedLong', ], 'failed' => [ 'shape' => 'UnsignedLong', ], 'timedOut' => [ 'shape' => 'UnsignedLong', ], 'aborted' => [ 'shape' => 'UnsignedLong', ], 'total' => [ 'shape' => 'UnsignedLong', ], 'resultsWritten' => [ 'shape' => 'UnsignedLong', ], 'failuresNotRedrivable' => [ 'shape' => 'LongObject', ], 'pendingRedrive' => [ 'shape' => 'LongObject', ], ], ], 'MapRunFailedEventDetails' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'MapRunItemCounts' => [ 'type' => 'structure', 'required' => [ 'pending', 'running', 'succeeded', 'failed', 'timedOut', 'aborted', 'total', 'resultsWritten', ], 'members' => [ 'pending' => [ 'shape' => 'UnsignedLong', ], 'running' => [ 'shape' => 'UnsignedLong', ], 'succeeded' => [ 'shape' => 'UnsignedLong', ], 'failed' => [ 'shape' => 'UnsignedLong', ], 'timedOut' => [ 'shape' => 'UnsignedLong', ], 'aborted' => [ 'shape' => 'UnsignedLong', ], 'total' => [ 'shape' => 'UnsignedLong', ], 'resultsWritten' => [ 'shape' => 'UnsignedLong', ], 'failuresNotRedrivable' => [ 'shape' => 'LongObject', ], 'pendingRedrive' => [ 'shape' => 'LongObject', ], ], ], 'MapRunLabel' => [ 'type' => 'string', ], 'MapRunList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MapRunListItem', ], ], 'MapRunListItem' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'mapRunArn', 'stateMachineArn', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'mapRunArn' => [ 'shape' => 'LongArn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], ], ], 'MapRunRedrivenEventDetails' => [ 'type' => 'structure', 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'redriveCount' => [ 'shape' => 'RedriveCount', ], ], ], 'MapRunStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], ], ], 'MapRunStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'SUCCEEDED', 'FAILED', 'ABORTED', ], ], 'MapStateStartedEventDetails' => [ 'type' => 'structure', 'members' => [ 'length' => [ 'shape' => 'UnsignedInteger', ], ], ], 'MaxConcurrency' => [ 'type' => 'integer', 'min' => 0, ], 'MissingRequiredParameter' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Name' => [ 'type' => 'string', 'max' => 80, 'min' => 1, ], 'PageSize' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'PageToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'Publish' => [ 'type' => 'boolean', ], 'PublishStateMachineVersionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'description' => [ 'shape' => 'VersionDescription', ], ], ], 'PublishStateMachineVersionOutput' => [ 'type' => 'structure', 'required' => [ 'creationDate', 'stateMachineVersionArn', ], 'members' => [ 'creationDate' => [ 'shape' => 'Timestamp', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'RedriveCount' => [ 'type' => 'integer', 'box' => true, ], 'RedriveExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'RedriveExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'redriveDate', ], 'members' => [ 'redriveDate' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceName' => [ 'shape' => 'Arn', ], ], 'exception' => true, ], 'RevealSecrets' => [ 'type' => 'boolean', ], 'ReverseOrder' => [ 'type' => 'boolean', ], 'RevisionId' => [ 'type' => 'string', ], 'RoutingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingConfigurationListItem', ], 'max' => 2, 'min' => 1, ], 'RoutingConfigurationListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', 'weight', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], 'weight' => [ 'shape' => 'VersionWeight', ], ], ], 'SendTaskFailureInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'SendTaskFailureOutput' => [ 'type' => 'structure', 'members' => [], ], 'SendTaskHeartbeatInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], ], ], 'SendTaskHeartbeatOutput' => [ 'type' => 'structure', 'members' => [], ], 'SendTaskSuccessInput' => [ 'type' => 'structure', 'required' => [ 'taskToken', 'output', ], 'members' => [ 'taskToken' => [ 'shape' => 'TaskToken', ], 'output' => [ 'shape' => 'SensitiveData', ], ], ], 'SendTaskSuccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'SensitiveCause' => [ 'type' => 'string', 'max' => 32768, 'min' => 0, 'sensitive' => true, ], 'SensitiveData' => [ 'type' => 'string', 'max' => 262144, 'sensitive' => true, ], 'SensitiveDataJobInput' => [ 'type' => 'string', 'max' => 262144, 'sensitive' => true, ], 'SensitiveError' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'sensitive' => true, ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StartExecutionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], ], ], 'StartExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'startDate', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'startDate' => [ 'shape' => 'Timestamp', ], ], ], 'StartSyncExecutionInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'includedData' => [ 'shape' => 'IncludedData', ], ], ], 'StartSyncExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'executionArn', 'startDate', 'stopDate', 'status', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'startDate' => [ 'shape' => 'Timestamp', ], 'stopDate' => [ 'shape' => 'Timestamp', ], 'status' => [ 'shape' => 'SyncExecutionStatus', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'CloudWatchEventsExecutionDataDetails', ], 'traceHeader' => [ 'shape' => 'TraceHeader', ], 'billingDetails' => [ 'shape' => 'BillingDetails', ], ], ], 'StateEnteredEventDetails' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'StateExitedEventDetails' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'StateMachineAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineAliasListItem', ], ], 'StateMachineAliasListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', 'creationDate', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'LongArn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateMachineAlreadyExists' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineDeleting' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineListItem', ], ], 'StateMachineListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', 'name', 'type', 'creationDate', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'StateMachineType', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateMachineStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', ], ], 'StateMachineType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'EXPRESS', ], ], 'StateMachineTypeNotSupported' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'StateMachineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StateMachineVersionListItem', ], ], 'StateMachineVersionListItem' => [ 'type' => 'structure', 'required' => [ 'stateMachineVersionArn', 'creationDate', ], 'members' => [ 'stateMachineVersionArn' => [ 'shape' => 'LongArn', ], 'creationDate' => [ 'shape' => 'Timestamp', ], ], ], 'StateName' => [ 'type' => 'string', 'max' => 80, 'min' => 1, ], 'StopExecutionInput' => [ 'type' => 'structure', 'required' => [ 'executionArn', ], 'members' => [ 'executionArn' => [ 'shape' => 'Arn', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'StopExecutionOutput' => [ 'type' => 'structure', 'required' => [ 'stopDate', ], 'members' => [ 'stopDate' => [ 'shape' => 'Timestamp', ], ], ], 'SyncExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'TIMED_OUT', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TaskCredentials' => [ 'type' => 'structure', 'members' => [ 'roleArn' => [ 'shape' => 'LongArn', ], ], ], 'TaskDoesNotExist' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TaskFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskScheduledEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', 'region', 'parameters', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'region' => [ 'shape' => 'Name', ], 'parameters' => [ 'shape' => 'ConnectorParameters', ], 'timeoutInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'heartbeatInSeconds' => [ 'shape' => 'TimeoutInSeconds', 'box' => true, ], 'taskCredentials' => [ 'shape' => 'TaskCredentials', ], ], ], 'TaskStartFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskStartedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], ], ], 'TaskSubmitFailedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskSubmittedEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'TaskSucceededEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'output' => [ 'shape' => 'SensitiveData', ], 'outputDetails' => [ 'shape' => 'HistoryEventExecutionDataDetails', ], ], ], 'TaskTimedOut' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'TaskTimedOutEventDetails' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resource', ], 'members' => [ 'resourceType' => [ 'shape' => 'Name', ], 'resource' => [ 'shape' => 'Name', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], ], ], 'TaskToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TestExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', 'RETRIABLE', 'CAUGHT_ERROR', ], ], 'TestStateInput' => [ 'type' => 'structure', 'required' => [ 'definition', 'roleArn', ], 'members' => [ 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'input' => [ 'shape' => 'SensitiveData', ], 'inspectionLevel' => [ 'shape' => 'InspectionLevel', ], 'revealSecrets' => [ 'shape' => 'RevealSecrets', ], ], ], 'TestStateOutput' => [ 'type' => 'structure', 'members' => [ 'output' => [ 'shape' => 'SensitiveData', ], 'error' => [ 'shape' => 'SensitiveError', ], 'cause' => [ 'shape' => 'SensitiveCause', ], 'inspectionData' => [ 'shape' => 'InspectionData', ], 'nextState' => [ 'shape' => 'StateName', ], 'status' => [ 'shape' => 'TestExecutionStatus', ], ], ], 'TimeoutInSeconds' => [ 'type' => 'long', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'ToleratedFailureCount' => [ 'type' => 'long', 'min' => 0, ], 'ToleratedFailurePercentage' => [ 'type' => 'float', 'max' => 100, 'min' => 0, ], 'TooManyTags' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'resourceName' => [ 'shape' => 'Arn', ], ], 'exception' => true, ], 'TraceHeader' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '\\p{ASCII}*', ], 'TracingConfiguration' => [ 'type' => 'structure', 'members' => [ 'enabled' => [ 'shape' => 'Enabled', ], ], ], 'URL' => [ 'type' => 'string', ], 'UnsignedInteger' => [ 'type' => 'integer', 'min' => 0, ], 'UnsignedLong' => [ 'type' => 'long', 'min' => 0, ], 'UntagResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'Arn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMapRunInput' => [ 'type' => 'structure', 'required' => [ 'mapRunArn', ], 'members' => [ 'mapRunArn' => [ 'shape' => 'LongArn', ], 'maxConcurrency' => [ 'shape' => 'MaxConcurrency', 'box' => true, ], 'toleratedFailurePercentage' => [ 'shape' => 'ToleratedFailurePercentage', 'box' => true, ], 'toleratedFailureCount' => [ 'shape' => 'ToleratedFailureCount', 'box' => true, ], ], ], 'UpdateMapRunOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateStateMachineAliasInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineAliasArn', ], 'members' => [ 'stateMachineAliasArn' => [ 'shape' => 'Arn', ], 'description' => [ 'shape' => 'AliasDescription', ], 'routingConfiguration' => [ 'shape' => 'RoutingConfigurationList', ], ], ], 'UpdateStateMachineAliasOutput' => [ 'type' => 'structure', 'required' => [ 'updateDate', ], 'members' => [ 'updateDate' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateStateMachineInput' => [ 'type' => 'structure', 'required' => [ 'stateMachineArn', ], 'members' => [ 'stateMachineArn' => [ 'shape' => 'Arn', ], 'definition' => [ 'shape' => 'Definition', ], 'roleArn' => [ 'shape' => 'Arn', ], 'loggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], 'tracingConfiguration' => [ 'shape' => 'TracingConfiguration', ], 'publish' => [ 'shape' => 'Publish', ], 'versionDescription' => [ 'shape' => 'VersionDescription', ], 'encryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], ], ], 'UpdateStateMachineOutput' => [ 'type' => 'structure', 'required' => [ 'updateDate', ], 'members' => [ 'updateDate' => [ 'shape' => 'Timestamp', ], 'revisionId' => [ 'shape' => 'RevisionId', ], 'stateMachineVersionArn' => [ 'shape' => 'Arn', ], ], ], 'ValidateStateMachineDefinitionCode' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionDiagnostic' => [ 'type' => 'structure', 'required' => [ 'severity', 'code', 'message', ], 'members' => [ 'severity' => [ 'shape' => 'ValidateStateMachineDefinitionSeverity', ], 'code' => [ 'shape' => 'ValidateStateMachineDefinitionCode', ], 'message' => [ 'shape' => 'ValidateStateMachineDefinitionMessage', ], 'location' => [ 'shape' => 'ValidateStateMachineDefinitionLocation', ], ], ], 'ValidateStateMachineDefinitionDiagnosticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidateStateMachineDefinitionDiagnostic', ], ], 'ValidateStateMachineDefinitionInput' => [ 'type' => 'structure', 'required' => [ 'definition', ], 'members' => [ 'definition' => [ 'shape' => 'Definition', ], 'type' => [ 'shape' => 'StateMachineType', ], 'severity' => [ 'shape' => 'ValidateStateMachineDefinitionSeverity', ], 'maxResults' => [ 'shape' => 'ValidateStateMachineDefinitionMaxResult', ], ], ], 'ValidateStateMachineDefinitionLocation' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionMaxResult' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ValidateStateMachineDefinitionMessage' => [ 'type' => 'string', ], 'ValidateStateMachineDefinitionOutput' => [ 'type' => 'structure', 'required' => [ 'result', 'diagnostics', ], 'members' => [ 'result' => [ 'shape' => 'ValidateStateMachineDefinitionResultCode', ], 'diagnostics' => [ 'shape' => 'ValidateStateMachineDefinitionDiagnosticList', ], 'truncated' => [ 'shape' => 'ValidateStateMachineDefinitionTruncated', ], ], ], 'ValidateStateMachineDefinitionResultCode' => [ 'type' => 'string', 'enum' => [ 'OK', 'FAIL', ], ], 'ValidateStateMachineDefinitionSeverity' => [ 'type' => 'string', 'enum' => [ 'ERROR', 'WARNING', ], ], 'ValidateStateMachineDefinitionTruncated' => [ 'type' => 'boolean', 'box' => true, ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'exception' => true, ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'API_DOES_NOT_SUPPORT_LABELED_ARNS', 'MISSING_REQUIRED_PARAMETER', 'CANNOT_UPDATE_COMPLETED_MAP_RUN', 'INVALID_ROUTING_CONFIGURATION', ], ], 'VersionDescription' => [ 'type' => 'string', 'max' => 256, 'sensitive' => true, ], 'VersionWeight' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'includedDetails' => [ 'type' => 'boolean', ], 'truncated' => [ 'type' => 'boolean', ], ],]; diff --git a/src/data/states/2016-11-23/docs-2.json b/src/data/states/2016-11-23/docs-2.json index 05123f8d11..44ebb41804 100644 --- a/src/data/states/2016-11-23/docs-2.json +++ b/src/data/states/2016-11-23/docs-2.json @@ -1729,6 +1729,12 @@ "ValidateStateMachineDefinitionDiagnostic$location": "

Location of the issue in the state machine, if available.

For errors specific to a field, the location could be in the format: /States/<StateName>/<FieldName>, for example: /States/FailState/ErrorPath.

" } }, + "ValidateStateMachineDefinitionMaxResult": { + "base": null, + "refs": { + "ValidateStateMachineDefinitionInput$maxResults": "

The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.

If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

" + } + }, "ValidateStateMachineDefinitionMessage": { "base": null, "refs": { @@ -1749,7 +1755,14 @@ "ValidateStateMachineDefinitionSeverity": { "base": null, "refs": { - "ValidateStateMachineDefinitionDiagnostic$severity": "

A value of ERROR means that you cannot create or update a state machine with this definition.

" + "ValidateStateMachineDefinitionDiagnostic$severity": "

A value of ERROR means that you cannot create or update a state machine with this definition.

", + "ValidateStateMachineDefinitionInput$severity": "

Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.

" + } + }, + "ValidateStateMachineDefinitionTruncated": { + "base": null, + "refs": { + "ValidateStateMachineDefinitionOutput$truncated": "

The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

" } }, "ValidationException": { diff --git a/src/data/states/2016-11-23/docs-2.json.php b/src/data/states/2016-11-23/docs-2.json.php index 253194c6f9..2ed91ebd1c 100644 --- a/src/data/states/2016-11-23/docs-2.json.php +++ b/src/data/states/2016-11-23/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Step Functions

Step Functions coordinates the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

', 'operations' => [ 'CreateActivity' => '

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity\'s idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'CreateStateMachine' => '

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine\'s idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

', 'CreateStateMachineAlias' => '

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client\'s code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

', 'DeleteActivity' => '

Deletes an activity.

', 'DeleteStateMachine' => '

Deletes a state machine. This is an asynchronous operation. It sets the state machine\'s status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine\'s executions are terminated.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

This API action also deletes all versions and aliases associated with a state machine.

For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

', 'DeleteStateMachineAlias' => '

Deletes a state machine alias.

After you delete a state machine alias, you can\'t use it to start executions. When you delete a state machine alias, Step Functions doesn\'t delete the state machine versions that alias references.

Related operations:

', 'DeleteStateMachineVersion' => '

Deletes a state machine version. After you delete a version, you can\'t call StartExecution using that version\'s ARN or use the version with a state machine alias.

Deleting a state machine version won\'t terminate its in-progress executions.

You can\'t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

Related operations:

', 'DescribeActivity' => '

Describes an activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'DescribeExecution' => '

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you\'ve redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Executions of an EXPRESS state machine aren\'t supported by DescribeExecution unless a Map Run dispatched them.

', 'DescribeMapRun' => '

Provides information about a Map Run\'s configuration, progress, and results. If you\'ve redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

', 'DescribeStateMachine' => '

Provides information about a state machine\'s definition, its IAM role Amazon Resource Name (ARN), and configuration.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'DescribeStateMachineAlias' => '

Returns details about a state machine alias.

Related operations:

', 'DescribeStateMachineForExecution' => '

Provides information about a state machine\'s definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

', 'GetActivityTask' => '

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

This API action isn\'t logged in CloudTrail.

Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

', 'GetExecutionHistory' => '

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

', 'ListActivities' => '

Lists the existing activities.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'ListExecutions' => '

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

Results are sorted by time, with the most recent execution first.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

', 'ListMapRuns' => '

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

', 'ListStateMachineAliases' => '

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

', 'ListStateMachineVersions' => '

Lists versions for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

', 'ListStateMachines' => '

Lists the existing state machines.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'ListTagsForResource' => '

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'PublishStateMachineVersion' => '

Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

PublishStateMachineVersion is an idempotent API. It doesn\'t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion\'s idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don\'t specify a revisionId, Step Functions checks for a previously published version of the state machine\'s current revision.

Related operations:

', 'RedriveExecution' => '

Restarts unsuccessful executions of Standard workflows that didn\'t complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn\'t rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

This API action is not supported by EXPRESS state machines.

However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

You can redrive executions if your original execution meets the following conditions:

', 'SendTaskFailure' => '

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

', 'SendTaskHeartbeat' => '

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine\'s Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine\'s Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

', 'SendTaskSuccess' => '

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

', 'StartExecution' => '

Starts a state machine execution.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version.

StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

StartExecution isn\'t idempotent for EXPRESS workflows.

', 'StartSyncExecution' => '

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn\'t reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn\'t logged in CloudTrail.

', 'StopExecution' => '

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

', 'TagResource' => '

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'TestState' => '

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

You can call this API on only one state at a time. The states that you can test include the following:

The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.

TestState doesn\'t support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

', 'UntagResource' => '

Remove a tag from a Step Functions resource

', 'UpdateMapRun' => '

Updates an in-progress Map Run\'s configuration to include changes to the settings that control maximum concurrency and Map Run failure.

', 'UpdateStateMachine' => '

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

', 'UpdateStateMachineAlias' => '

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response.

This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.

Related operations:

', 'ValidateStateMachineDefinition' => '

Validates the syntax of a state machine definition.

You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke CreateStateMachine and UpdateStateMachine. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).

Suggested uses for ValidateStateMachineDefinition:

Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.

', ], 'shapes' => [ 'ActivityAlreadyExists' => [ 'base' => '

Activity already exists. EncryptionConfiguration may not be updated.

', 'refs' => [], ], 'ActivityDoesNotExist' => [ 'base' => '

The specified activity does not exist.

', 'refs' => [], ], 'ActivityFailedEventDetails' => [ 'base' => '

Contains details about an activity that failed during an execution.

', 'refs' => [ 'HistoryEvent$activityFailedEventDetails' => NULL, ], ], 'ActivityLimitExceeded' => [ 'base' => '

The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

', 'refs' => [], ], 'ActivityList' => [ 'base' => NULL, 'refs' => [ 'ListActivitiesOutput$activities' => '

The list of activities.

', ], ], 'ActivityListItem' => [ 'base' => '

Contains details about an activity.

', 'refs' => [ 'ActivityList$member' => NULL, ], ], 'ActivityScheduleFailedEventDetails' => [ 'base' => '

Contains details about an activity schedule failure that occurred during an execution.

', 'refs' => [ 'HistoryEvent$activityScheduleFailedEventDetails' => '

Contains details about an activity schedule event that failed during an execution.

', ], ], 'ActivityScheduledEventDetails' => [ 'base' => '

Contains details about an activity scheduled during an execution.

', 'refs' => [ 'HistoryEvent$activityScheduledEventDetails' => NULL, ], ], 'ActivityStartedEventDetails' => [ 'base' => '

Contains details about the start of an activity during an execution.

', 'refs' => [ 'HistoryEvent$activityStartedEventDetails' => NULL, ], ], 'ActivitySucceededEventDetails' => [ 'base' => '

Contains details about an activity that successfully terminated during an execution.

', 'refs' => [ 'HistoryEvent$activitySucceededEventDetails' => NULL, ], ], 'ActivityTimedOutEventDetails' => [ 'base' => '

Contains details about an activity timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$activityTimedOutEventDetails' => NULL, ], ], 'ActivityWorkerLimitExceeded' => [ 'base' => '

The maximum number of workers concurrently polling for activity tasks has been reached.

', 'refs' => [], ], 'AliasDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$description' => '

A description for the state machine alias.

', 'DescribeStateMachineAliasOutput$description' => '

A description of the alias.

', 'UpdateStateMachineAliasInput$description' => '

A description of the state machine alias.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$activityArn' => '

The Amazon Resource Name (ARN) that identifies the activity.

', 'ActivityScheduledEventDetails$resource' => '

The Amazon Resource Name (ARN) of the scheduled activity.

', 'CloudWatchLogsLogGroup$logGroupArn' => '

The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

', 'CreateActivityOutput$activityArn' => '

The Amazon Resource Name (ARN) that identifies the created activity.

', 'CreateStateMachineAliasOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine alias.

', 'CreateStateMachineInput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

', 'CreateStateMachineOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine.

', 'CreateStateMachineOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.

', 'DeleteActivityInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to delete.

', 'DeleteStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias to delete.

', 'DeleteStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to delete.

', 'DescribeActivityInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to describe.

', 'DescribeActivityOutput$activityArn' => '

The Amazon Resource Name (ARN) that identifies the activity.

', 'DescribeExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to describe.

', 'DescribeExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'DescribeExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the executed stated machine.

', 'DescribeExecutionOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

', 'DescribeExecutionOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

', 'DescribeMapRunOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

', 'DescribeStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'DescribeStateMachineAliasOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'DescribeStateMachineForExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution you want state machine information for.

', 'DescribeStateMachineForExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine associated with the execution.

', 'DescribeStateMachineForExecutionOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

', 'DescribeStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine for which you want the information.

If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'DescribeStateMachineOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'DescribeStateMachineOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

', 'ExecutionListItem$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'ExecutionListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine that ran the execution.

', 'ExecutionListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version associated with the execution.

If the state machine execution was started with an unqualified ARN, it returns null.

If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

', 'ExecutionListItem$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

', 'ExecutionStartedEventDetails$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.

', 'ExecutionStartedEventDetails$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.

', 'ExecutionStartedEventDetails$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.

', 'GetActivityTaskInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

', 'GetExecutionHistoryInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution.

', 'LambdaFunctionScheduledEventDetails$resource' => '

The Amazon Resource Name (ARN) of the scheduled Lambda function.

', 'ListExecutionsInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

', 'ListMapRunsInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

', 'ListStateMachineAliasesInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

If you specify a state machine version ARN, this API returns a list of aliases for that version.

', 'ListStateMachineVersionsInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'ListTagsForResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'MapRunListItem$executionArn' => '

The executionArn of the execution from which the Map Run was started.

', 'MapRunListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) of the executed state machine.

', 'PublishStateMachineVersionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'PublishStateMachineVersionOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.

', 'RedriveExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to be redriven.

', 'ResourceNotFound$resourceName' => NULL, 'RoutingConfigurationListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.

If you specify the ARN of a second version, it must belong to the same state machine as the first version.

', 'StartExecutionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to execute.

The stateMachineArn parameter accepts one of the following inputs:

', 'StartExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'StartSyncExecutionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to execute.

', 'StartSyncExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'StartSyncExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

', 'StateMachineListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

', 'StopExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to stop.

', 'TagResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'TestStateInput$roleArn' => '

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

', 'TooManyTags$resourceName' => NULL, 'UntagResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'UpdateStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'UpdateStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'UpdateStateMachineInput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role of the state machine.

', 'UpdateStateMachineOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the published state machine version.

If the publish parameter isn\'t set to true, this field returns null.

', ], ], 'BilledDuration' => [ 'base' => NULL, 'refs' => [ 'BillingDetails$billedDurationInMilliseconds' => '

Billed duration of your workflow, in milliseconds.

', ], ], 'BilledMemoryUsed' => [ 'base' => NULL, 'refs' => [ 'BillingDetails$billedMemoryUsedInMB' => '

Billed memory consumption of your workflow, in MB.

', ], ], 'BillingDetails' => [ 'base' => '

An object that describes workflow billing details.

', 'refs' => [ 'StartSyncExecutionOutput$billingDetails' => '

An object that describes workflow billing details, including billed duration and memory use.

', ], ], 'CharacterRestrictedName' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$name' => '

The name of the state machine alias.

To avoid conflict with version ARNs, don\'t use an integer in the name of the alias.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'RedriveExecutionInput$clientToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.

', ], ], 'CloudWatchEventsExecutionDataDetails' => [ 'base' => '

Provides details about execution input or output.

', 'refs' => [ 'DescribeExecutionOutput$inputDetails' => NULL, 'DescribeExecutionOutput$outputDetails' => NULL, 'StartSyncExecutionOutput$inputDetails' => NULL, 'StartSyncExecutionOutput$outputDetails' => NULL, ], ], 'CloudWatchLogsLogGroup' => [ 'base' => '

', 'refs' => [ 'LogDestination$cloudWatchLogsLogGroup' => '

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

', ], ], 'ConflictException' => [ 'base' => '

Updating or deleting a resource can cause an inconsistent state. This error occurs when there\'re concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

', 'refs' => [], ], 'ConnectorParameters' => [ 'base' => NULL, 'refs' => [ 'TaskScheduledEventDetails$parameters' => '

The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'CreateActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Definition' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'DescribeStateMachineForExecutionOutput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'DescribeStateMachineOutput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

If called with includedData = METADATA_ONLY, the returned definition will be {}.

', 'TestStateInput$definition' => '

The Amazon States Language (ASL) definition of the state.

', 'UpdateStateMachineInput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'ValidateStateMachineDefinitionInput$definition' => '

The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).

', ], ], 'DeleteActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'TracingConfiguration$enabled' => '

When set to true, X-Ray tracing is enabled.

', ], ], 'EncryptionConfiguration' => [ 'base' => '

Settings to configure server-side encryption.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines and activities. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine, and when creating an Activity. The execution history and state machine definition will be encrypted with the key applied to the State Machine. Activity inputs will be encrypted with the key applied to the Activity.

Step Functions automatically enables encryption at rest using Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see Key Management Service pricing.

For more information on KMS, see What is Key Management Service?

', 'refs' => [ 'CreateActivityInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'CreateStateMachineInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'DescribeActivityOutput$encryptionConfiguration' => '

Settings for configured server-side encryption.

', 'DescribeStateMachineForExecutionOutput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'DescribeStateMachineOutput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'UpdateStateMachineInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$type' => '

Encryption type

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ActivityAlreadyExists$message' => NULL, 'ActivityDoesNotExist$message' => NULL, 'ActivityLimitExceeded$message' => NULL, 'ActivityWorkerLimitExceeded$message' => NULL, 'ConflictException$message' => NULL, 'ExecutionAlreadyExists$message' => NULL, 'ExecutionDoesNotExist$message' => NULL, 'ExecutionLimitExceeded$message' => NULL, 'ExecutionNotRedrivable$message' => NULL, 'InvalidArn$message' => NULL, 'InvalidDefinition$message' => NULL, 'InvalidEncryptionConfiguration$message' => NULL, 'InvalidExecutionInput$message' => NULL, 'InvalidLoggingConfiguration$message' => NULL, 'InvalidName$message' => NULL, 'InvalidOutput$message' => NULL, 'InvalidToken$message' => NULL, 'InvalidTracingConfiguration$message' => NULL, 'KmsAccessDeniedException$message' => NULL, 'KmsInvalidStateException$message' => NULL, 'KmsThrottlingException$message' => NULL, 'MissingRequiredParameter$message' => NULL, 'ResourceNotFound$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'StateMachineAlreadyExists$message' => NULL, 'StateMachineDeleting$message' => NULL, 'StateMachineDoesNotExist$message' => NULL, 'StateMachineLimitExceeded$message' => NULL, 'StateMachineTypeNotSupported$message' => NULL, 'TaskDoesNotExist$message' => NULL, 'TaskTimedOut$message' => NULL, 'TooManyTags$message' => NULL, 'ValidationException$message' => NULL, ], ], 'EventId' => [ 'base' => NULL, 'refs' => [ 'HistoryEvent$id' => '

The id of the event. Events are numbered sequentially, starting at one.

', 'HistoryEvent$previousEventId' => '

The id of the previous event.

', ], ], 'ExecutionAbortedEventDetails' => [ 'base' => '

Contains details about an abort of an execution.

', 'refs' => [ 'HistoryEvent$executionAbortedEventDetails' => NULL, ], ], 'ExecutionAlreadyExists' => [ 'base' => '

The execution has the same name as another execution (but a different input).

Executions with the same name and input are considered idempotent.

', 'refs' => [], ], 'ExecutionDoesNotExist' => [ 'base' => '

The specified execution does not exist.

', 'refs' => [], ], 'ExecutionFailedEventDetails' => [ 'base' => '

Contains details about an execution failure event.

', 'refs' => [ 'HistoryEvent$executionFailedEventDetails' => NULL, ], ], 'ExecutionLimitExceeded' => [ 'base' => '

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

', 'refs' => [], ], 'ExecutionList' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsOutput$executions' => '

The list of matching executions.

', ], ], 'ExecutionListItem' => [ 'base' => '

Contains details about an execution.

', 'refs' => [ 'ExecutionList$member' => NULL, ], ], 'ExecutionNotRedrivable' => [ 'base' => '

The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.

', 'refs' => [], ], 'ExecutionRedriveFilter' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsInput$redriveFilter' => '

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

', ], ], 'ExecutionRedriveStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$redriveStatus' => '

Indicates whether or not an execution can be redriven at a given point in time.

', ], ], 'ExecutionRedrivenEventDetails' => [ 'base' => '

Contains details about a redriven execution.

', 'refs' => [ 'HistoryEvent$executionRedrivenEventDetails' => '

Contains details about the redrive attempt of an execution.

', ], ], 'ExecutionStartedEventDetails' => [ 'base' => '

Contains details about the start of the execution.

', 'refs' => [ 'HistoryEvent$executionStartedEventDetails' => NULL, ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$status' => '

The current status of the execution.

', 'ExecutionListItem$status' => '

The current status of the execution.

', 'ListExecutionsInput$statusFilter' => '

If specified, only list the executions whose current execution status matches the given filter.

', ], ], 'ExecutionSucceededEventDetails' => [ 'base' => '

Contains details about the successful termination of the execution.

', 'refs' => [ 'HistoryEvent$executionSucceededEventDetails' => NULL, ], ], 'ExecutionTimedOutEventDetails' => [ 'base' => '

Contains details about the execution timeout that occurred during the execution.

', 'refs' => [ 'HistoryEvent$executionTimedOutEventDetails' => NULL, ], ], 'GetActivityTaskInput' => [ 'base' => NULL, 'refs' => [], ], 'GetActivityTaskOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'HTTPBody' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$body' => '

The request body for the HTTP request.

', 'InspectionDataResponse$body' => '

The HTTP response returned.

', ], ], 'HTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$headers' => '

The request headers associated with the HTTP request.

', 'InspectionDataResponse$headers' => '

The response headers associated with the HTTP response.

', ], ], 'HTTPMethod' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$method' => '

The HTTP method used for the HTTP request.

', ], ], 'HTTPProtocol' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$protocol' => '

The protocol used to make the HTTP request.

', 'InspectionDataResponse$protocol' => '

The protocol used to return the HTTP response.

', ], ], 'HTTPStatusCode' => [ 'base' => NULL, 'refs' => [ 'InspectionDataResponse$statusCode' => '

The HTTP response status code for the HTTP response.

', ], ], 'HTTPStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InspectionDataResponse$statusMessage' => '

The message associated with the HTTP status code.

', ], ], 'HistoryEvent' => [ 'base' => '

Contains details about the events of an execution.

', 'refs' => [ 'HistoryEventList$member' => NULL, ], ], 'HistoryEventExecutionDataDetails' => [ 'base' => '

Provides details about input or output in an execution history event.

', 'refs' => [ 'ActivityScheduledEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'ActivitySucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'ExecutionStartedEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'ExecutionSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'LambdaFunctionScheduledEventDetails$inputDetails' => '

Contains details about input for an execution history event.

', 'LambdaFunctionSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'StateEnteredEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'StateExitedEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'TaskSubmittedEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'TaskSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', ], ], 'HistoryEventList' => [ 'base' => '

Contains details about the events that occurred during an execution.

', 'refs' => [ 'GetExecutionHistoryOutput$events' => '

The list of events that occurred in the execution.

', ], ], 'HistoryEventType' => [ 'base' => NULL, 'refs' => [ 'HistoryEvent$type' => '

The type of the event.

', ], ], 'Identity' => [ 'base' => NULL, 'refs' => [ 'ActivityStartedEventDetails$workerName' => '

The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.

', ], ], 'IncludeExecutionData' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$includeExecutionData' => '

Determines whether execution data is included in your log. When set to false, data is excluded.

', ], ], 'IncludeExecutionDataGetExecutionHistory' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$includeExecutionData' => '

You can select whether execution data (input or output of a history event) is returned. The default is true.

', ], ], 'IncludedData' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call DescribeStateMachine API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', 'DescribeStateMachineForExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', 'DescribeStateMachineInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

', 'StartSyncExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', ], ], 'InspectionData' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP request and response information.

', 'refs' => [ 'TestStateOutput$inspectionData' => '

Returns additional details about the state\'s execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.

', ], ], 'InspectionDataRequest' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP request information.

', 'refs' => [ 'InspectionData$request' => '

The raw HTTP request that is sent when you test an HTTP Task.

', ], ], 'InspectionDataResponse' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP response information. The inspectionLevel request parameter specifies which details are returned.

', 'refs' => [ 'InspectionData$response' => '

The raw HTTP response that is returned when you test an HTTP Task.

', ], ], 'InspectionLevel' => [ 'base' => NULL, 'refs' => [ 'TestStateInput$inspectionLevel' => '

Determines the values to return when a state is tested. You can specify one of the following types:

Each of these levels also provide information about the status of the state execution and the next state to transition to.

', ], ], 'InvalidArn' => [ 'base' => '

The provided Amazon Resource Name (ARN) is not valid.

', 'refs' => [], ], 'InvalidDefinition' => [ 'base' => '

The provided Amazon States Language definition is not valid.

', 'refs' => [], ], 'InvalidEncryptionConfiguration' => [ 'base' => '

Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.

', 'refs' => [], ], 'InvalidExecutionInput' => [ 'base' => '

The provided JSON input data is not valid.

', 'refs' => [], ], 'InvalidLoggingConfiguration' => [ 'base' => '

Configuration is not valid.

', 'refs' => [], ], 'InvalidName' => [ 'base' => '

The provided name is not valid.

', 'refs' => [], ], 'InvalidOutput' => [ 'base' => '

The provided JSON output data is not valid.

', 'refs' => [], ], 'InvalidToken' => [ 'base' => '

The provided token is not valid.

', 'refs' => [], ], 'InvalidTracingConfiguration' => [ 'base' => '

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

', 'refs' => [], ], 'KmsAccessDeniedException' => [ 'base' => '

Either your KMS key policy or API caller does not have the required permissions.

', 'refs' => [], ], 'KmsDataKeyReusePeriodSeconds' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsDataKeyReusePeriodSeconds' => '

Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.

', ], ], 'KmsInvalidStateException' => [ 'base' => '

The KMS key is not in valid state, for example: Disabled or Deleted.

', 'refs' => [], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyId' => '

An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

', ], ], 'KmsKeyState' => [ 'base' => NULL, 'refs' => [ 'KmsInvalidStateException$kmsKeyState' => '

Current status of the KMS; key. For example: DISABLED, PENDING_DELETION, PENDING_IMPORT, UNAVAILABLE, CREATING.

', ], ], 'KmsThrottlingException' => [ 'base' => '

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

', 'refs' => [], ], 'LambdaFunctionFailedEventDetails' => [ 'base' => '

Contains details about a Lambda function that failed during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduleFailedEventDetails' => [ 'base' => '

Contains details about a failed Lambda function schedule event that occurred during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduleFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduledEventDetails' => [ 'base' => '

Contains details about a Lambda function scheduled during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduledEventDetails' => NULL, ], ], 'LambdaFunctionStartFailedEventDetails' => [ 'base' => '

Contains details about a lambda function that failed to start during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionStartFailedEventDetails' => '

Contains details about a lambda function that failed to start during an execution.

', ], ], 'LambdaFunctionSucceededEventDetails' => [ 'base' => '

Contains details about a Lambda function that successfully terminated during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionSucceededEventDetails' => '

Contains details about a Lambda function that terminated successfully during an execution.

', ], ], 'LambdaFunctionTimedOutEventDetails' => [ 'base' => '

Contains details about a Lambda function timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionTimedOutEventDetails' => NULL, ], ], 'ListActivitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListActivitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsPageToken' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListExecutionsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', ], ], 'ListMapRunsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListMapRunsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineAliasesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineAliasesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineVersionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogDestination' => [ 'base' => '

', 'refs' => [ 'LogDestinationList$member' => NULL, ], ], 'LogDestinationList' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$destinations' => '

An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.

', ], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$level' => '

Defines which category of execution history events are logged.

', ], ], 'LoggingConfiguration' => [ 'base' => '

The LoggingConfiguration data type is used to set CloudWatch Logs options.

', 'refs' => [ 'CreateStateMachineInput$loggingConfiguration' => '

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

', 'DescribeStateMachineForExecutionOutput$loggingConfiguration' => NULL, 'DescribeStateMachineOutput$loggingConfiguration' => NULL, 'UpdateStateMachineInput$loggingConfiguration' => '

Use the LoggingConfiguration data type to set CloudWatch Logs options.

', ], ], 'LongArn' => [ 'base' => NULL, 'refs' => [ 'DeleteStateMachineVersionInput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version to delete.

', 'DescribeExecutionOutput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

', 'DescribeMapRunInput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run.

', 'DescribeMapRunOutput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run.

', 'DescribeStateMachineForExecutionOutput$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

', 'ExecutionListItem$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn\'t returned.

', 'ListExecutionsInput$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

', 'MapRunListItem$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run.

', 'MapRunRedrivenEventDetails$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run that was redriven.

', 'MapRunStartedEventDetails$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run that was started.

', 'StateMachineAliasListItem$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

', 'StateMachineVersionListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'TaskCredentials$roleArn' => '

The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.

', 'UpdateMapRunInput$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run.

', ], ], 'LongObject' => [ 'base' => NULL, 'refs' => [ 'MapRunExecutionCounts$failuresNotRedrivable' => '

The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

', 'MapRunExecutionCounts$pendingRedrive' => '

The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.

', 'MapRunItemCounts$failuresNotRedrivable' => '

The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

', 'MapRunItemCounts$pendingRedrive' => '

The number of unsuccessful items in child workflow executions currently waiting to be redriven.

', ], ], 'MapIterationEventDetails' => [ 'base' => '

Contains details about an iteration of a Map state.

', 'refs' => [ 'HistoryEvent$mapIterationStartedEventDetails' => '

Contains details about an iteration of a Map state that was started.

', 'HistoryEvent$mapIterationSucceededEventDetails' => '

Contains details about an iteration of a Map state that succeeded.

', 'HistoryEvent$mapIterationFailedEventDetails' => '

Contains details about an iteration of a Map state that failed.

', 'HistoryEvent$mapIterationAbortedEventDetails' => '

Contains details about an iteration of a Map state that was aborted.

', ], ], 'MapRunExecutionCounts' => [ 'base' => '

Contains details about all of the child workflow executions started by a Map Run.

', 'refs' => [ 'DescribeMapRunOutput$executionCounts' => '

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

', ], ], 'MapRunFailedEventDetails' => [ 'base' => '

Contains details about a Map Run failure event that occurred during a state machine execution.

', 'refs' => [ 'HistoryEvent$mapRunFailedEventDetails' => '

Contains error and cause details about a Map Run that failed.

', ], ], 'MapRunItemCounts' => [ 'base' => '

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

', 'refs' => [ 'DescribeMapRunOutput$itemCounts' => '

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

', ], ], 'MapRunLabel' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineForExecutionOutput$label' => '

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

', 'DescribeStateMachineOutput$label' => '

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

', ], ], 'MapRunList' => [ 'base' => NULL, 'refs' => [ 'ListMapRunsOutput$mapRuns' => '

An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

', ], ], 'MapRunListItem' => [ 'base' => '

Contains details about a specific Map Run.

', 'refs' => [ 'MapRunList$member' => NULL, ], ], 'MapRunRedrivenEventDetails' => [ 'base' => '

Contains details about a Map Run that was redriven.

', 'refs' => [ 'HistoryEvent$mapRunRedrivenEventDetails' => '

Contains details about the redrive attempt of a Map Run.

', ], ], 'MapRunStartedEventDetails' => [ 'base' => '

Contains details about a Map Run that was started during a state machine execution.

', 'refs' => [ 'HistoryEvent$mapRunStartedEventDetails' => '

Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.

', ], ], 'MapRunStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$status' => '

The current status of the Map Run.

', ], ], 'MapStateStartedEventDetails' => [ 'base' => '

Details about a Map state that was started.

', 'refs' => [ 'HistoryEvent$mapStateStartedEventDetails' => '

Contains details about Map state that was started.

', ], ], 'MaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$maxConcurrency' => '

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

', 'UpdateMapRunInput$maxConcurrency' => '

The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.

', ], ], 'MissingRequiredParameter' => [ 'base' => '

Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

', 'refs' => [], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$name' => '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'CreateActivityInput$name' => '

The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'CreateStateMachineInput$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeActivityOutput$name' => '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeExecutionOutput$name' => '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeStateMachineAliasOutput$name' => '

The name of the state machine alias.

', 'DescribeStateMachineForExecutionOutput$name' => '

The name of the state machine associated with the execution.

', 'DescribeStateMachineOutput$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'ExecutionListItem$name' => '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'GetActivityTaskInput$workerName' => '

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

', 'MapIterationEventDetails$name' => '

The name of the iteration’s parent Map state.

', 'StartExecutionInput$name' => '

Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

If you don\'t provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'StartSyncExecutionInput$name' => '

The name of the execution.

', 'StartSyncExecutionOutput$name' => '

The name of the execution.

', 'StateEnteredEventDetails$name' => '

The name of the state.

', 'StateExitedEventDetails$name' => '

The name of the state.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'StateMachineListItem$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'TaskFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskScheduledEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskScheduledEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskScheduledEventDetails$region' => '

The region of the scheduled task

', 'TaskStartFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskStartFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskStartedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskStartedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSubmitFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSubmitFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSubmittedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSubmittedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSucceededEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSucceededEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskTimedOutEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskTimedOutEventDetails$resource' => '

The action of the resource called by a task state.

', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListActivitiesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListExecutionsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListMapRunsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachineAliasesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachineVersionsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachinesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'GetExecutionHistoryOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListActivitiesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListActivitiesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListMapRunsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListMapRunsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineAliasesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineAliasesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineVersionsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineVersionsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachinesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachinesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', ], ], 'Publish' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$publish' => '

Set to true to publish the first version of the state machine during creation. The default is false.

', 'UpdateStateMachineInput$publish' => '

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

', ], ], 'PublishStateMachineVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'PublishStateMachineVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'RedriveCount' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

', 'DescribeMapRunOutput$redriveCount' => '

The number of times you\'ve redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.

', 'ExecutionListItem$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

', 'ExecutionRedrivenEventDetails$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

', 'MapRunRedrivenEventDetails$redriveCount' => '

The number of times the Map Run has been redriven at this point in the execution\'s history including this event. The redrive count for a redriven Map Run is always greater than 0.

', ], ], 'RedriveExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'RedriveExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFound' => [ 'base' => '

Could not find the referenced resource.

', 'refs' => [], ], 'RevealSecrets' => [ 'base' => NULL, 'refs' => [ 'TestStateInput$revealSecrets' => '

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn\'t omit any information included in the state definition or the HTTP response.

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

By default, revealSecrets is set to false.

', ], ], 'ReverseOrder' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$reverseOrder' => '

Lists events in descending order of their timeStamp.

', ], ], 'RevisionId' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineForExecutionOutput$revisionId' => '

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

', 'DescribeStateMachineOutput$revisionId' => '

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

', 'PublishStateMachineVersionInput$revisionId' => '

Only publish the state machine version if the current state machine\'s revision ID matches the specified ID.

Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn\'t match the state machine\'s current revision ID, the API returns ConflictException.

To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.

', 'UpdateStateMachineOutput$revisionId' => '

The revision identifier for the updated state machine.

', ], ], 'RoutingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$routingConfiguration' => '

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.

', 'DescribeStateMachineAliasOutput$routingConfiguration' => '

The routing configuration of the alias.

', 'UpdateStateMachineAliasInput$routingConfiguration' => '

The routing configuration of the state machine alias.

An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.

', ], ], 'RoutingConfigurationListItem' => [ 'base' => '

Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.

', 'refs' => [ 'RoutingConfigurationList$member' => NULL, ], ], 'SendTaskFailureInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskFailureOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveCause' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ActivityScheduleFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ActivityTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'DescribeExecutionOutput$cause' => '

The cause string if the state machine execution failed.

', 'ExecutionAbortedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ExecutionFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ExecutionTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'LambdaFunctionFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionScheduleFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionStartFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'MapRunFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'SendTaskFailureInput$cause' => '

A more detailed explanation of the cause of the failure.

', 'StartSyncExecutionOutput$cause' => '

A more detailed explanation of the cause of the failure.

', 'StopExecutionInput$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskStartFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskSubmitFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TestStateOutput$cause' => '

A detailed explanation of the cause for the error when the execution of a state fails.

', ], ], 'SensitiveData' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$input' => '

The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'ActivitySucceededEventDetails$output' => '

The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'DescribeExecutionOutput$input' => '

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'DescribeExecutionOutput$output' => '

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

', 'DescribeExecutionOutput$redriveStatusReason' => '

When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

', 'ExecutionStartedEventDetails$input' => '

The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'ExecutionSucceededEventDetails$output' => '

The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'InspectionData$input' => '

The raw state input.

', 'InspectionData$afterInputPath' => '

The input after Step Functions applies the InputPath filter.

', 'InspectionData$afterParameters' => '

The effective input after Step Functions applies the Parameters filter.

', 'InspectionData$result' => '

The state\'s raw result.

', 'InspectionData$afterResultSelector' => '

The effective result after Step Functions applies the ResultSelector filter.

', 'InspectionData$afterResultPath' => '

The effective result combined with the raw state input after Step Functions applies the ResultPath filter.

', 'LambdaFunctionScheduledEventDetails$input' => '

The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'LambdaFunctionSucceededEventDetails$output' => '

The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'SendTaskSuccessInput$output' => '

The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartExecutionInput$input' => '

The string that contains the JSON input data for the execution, for example:

"input": "{\\"first_name\\" : \\"test\\"}"

If you don\'t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionInput$input' => '

The string that contains the JSON input data for the execution, for example:

"input": "{\\"first_name\\" : \\"test\\"}"

If you don\'t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionOutput$input' => '

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionOutput$output' => '

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

', 'StateEnteredEventDetails$input' => '

The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StateExitedEventDetails$output' => '

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TaskSubmittedEventDetails$output' => '

The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TaskSucceededEventDetails$output' => '

The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TestStateInput$input' => '

A string that contains the JSON input data for the state.

', 'TestStateOutput$output' => '

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'SensitiveDataJobInput' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$input' => '

The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'SensitiveError' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$error' => '

The error code of the failure.

', 'ActivityScheduleFailedEventDetails$error' => '

The error code of the failure.

', 'ActivityTimedOutEventDetails$error' => '

The error code of the failure.

', 'DescribeExecutionOutput$error' => '

The error string if the state machine execution failed.

', 'ExecutionAbortedEventDetails$error' => '

The error code of the failure.

', 'ExecutionFailedEventDetails$error' => '

The error code of the failure.

', 'ExecutionTimedOutEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionScheduleFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionStartFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionTimedOutEventDetails$error' => '

The error code of the failure.

', 'MapRunFailedEventDetails$error' => '

The error code of the Map Run failure.

', 'SendTaskFailureInput$error' => '

The error code of the failure.

', 'StartSyncExecutionOutput$error' => '

The error code of the failure.

', 'StopExecutionInput$error' => '

The error code of the failure.

', 'TaskFailedEventDetails$error' => '

The error code of the failure.

', 'TaskStartFailedEventDetails$error' => '

The error code of the failure.

', 'TaskSubmitFailedEventDetails$error' => '

The error code of the failure.

', 'TaskTimedOutEventDetails$error' => '

The error code of the failure.

', 'TestStateOutput$error' => '

The error returned when the execution of a state fails.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

', 'refs' => [], ], 'StartExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StateEnteredEventDetails' => [ 'base' => '

Contains details about a state entered during an execution.

', 'refs' => [ 'HistoryEvent$stateEnteredEventDetails' => NULL, ], ], 'StateExitedEventDetails' => [ 'base' => '

Contains details about an exit from a state during an execution.

', 'refs' => [ 'HistoryEvent$stateExitedEventDetails' => NULL, ], ], 'StateMachineAliasList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachineAliasesOutput$stateMachineAliases' => '

Aliases for the state machine.

', ], ], 'StateMachineAliasListItem' => [ 'base' => '

Contains details about a specific state machine alias.

', 'refs' => [ 'StateMachineAliasList$member' => NULL, ], ], 'StateMachineAlreadyExists' => [ 'base' => '

A state machine with the same name but a different definition or role ARN already exists.

', 'refs' => [], ], 'StateMachineDeleting' => [ 'base' => '

The specified state machine is being deleted.

', 'refs' => [], ], 'StateMachineDoesNotExist' => [ 'base' => '

The specified state machine does not exist.

', 'refs' => [], ], 'StateMachineLimitExceeded' => [ 'base' => '

The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

', 'refs' => [], ], 'StateMachineList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachinesOutput$stateMachines' => NULL, ], ], 'StateMachineListItem' => [ 'base' => '

Contains details about the state machine.

', 'refs' => [ 'StateMachineList$member' => NULL, ], ], 'StateMachineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineOutput$status' => '

The current status of the state machine.

', ], ], 'StateMachineType' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$type' => '

Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

', 'DescribeStateMachineOutput$type' => '

The type of the state machine (STANDARD or EXPRESS).

', 'StateMachineListItem$type' => '

', 'ValidateStateMachineDefinitionInput$type' => '

The target type of state machine for this definition. The default is STANDARD.

', ], ], 'StateMachineTypeNotSupported' => [ 'base' => '

State machine type is not supported.

', 'refs' => [], ], 'StateMachineVersionList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachineVersionsOutput$stateMachineVersions' => '

Versions for the state machine.

', ], ], 'StateMachineVersionListItem' => [ 'base' => '

Contains details about a specific state machine version.

', 'refs' => [ 'StateMachineVersionList$member' => NULL, ], ], 'StateName' => [ 'base' => NULL, 'refs' => [ 'TestStateOutput$nextState' => '

The name of the next state to transition to. If you haven\'t defined a next state in your definition or if the execution of the state fails, this field doesn\'t contain a value.

', ], ], 'StopExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StopExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'SyncExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'StartSyncExecutionOutput$status' => '

The current status of the execution.

', ], ], 'Tag' => [ 'base' => '

Tags are key-value pairs that can be associated with Step Functions state machines and activities.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key of a tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => '

The list of tags to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateActivityInput$tags' => '

The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'CreateStateMachineInput$tags' => '

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'ListTagsForResourceOutput$tags' => '

An array of tags associated with the resource.

', 'TagResourceInput$tags' => '

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value of a tag.

', ], ], 'TaskCredentials' => [ 'base' => '

Contains details about the credentials that Step Functions uses for a task.

', 'refs' => [ 'LambdaFunctionScheduledEventDetails$taskCredentials' => '

The credentials that Step Functions uses for the task.

', 'TaskScheduledEventDetails$taskCredentials' => '

The credentials that Step Functions uses for the task.

', ], ], 'TaskDoesNotExist' => [ 'base' => '

The activity does not exist.

', 'refs' => [], ], 'TaskFailedEventDetails' => [ 'base' => '

Contains details about a task failure event.

', 'refs' => [ 'HistoryEvent$taskFailedEventDetails' => '

Contains details about the failure of a task.

', ], ], 'TaskScheduledEventDetails' => [ 'base' => '

Contains details about a task scheduled during an execution.

', 'refs' => [ 'HistoryEvent$taskScheduledEventDetails' => '

Contains details about a task that was scheduled.

', ], ], 'TaskStartFailedEventDetails' => [ 'base' => '

Contains details about a task that failed to start during an execution.

', 'refs' => [ 'HistoryEvent$taskStartFailedEventDetails' => '

Contains details about a task that failed to start.

', ], ], 'TaskStartedEventDetails' => [ 'base' => '

Contains details about the start of a task during an execution.

', 'refs' => [ 'HistoryEvent$taskStartedEventDetails' => '

Contains details about a task that was started.

', ], ], 'TaskSubmitFailedEventDetails' => [ 'base' => '

Contains details about a task that failed to submit during an execution.

', 'refs' => [ 'HistoryEvent$taskSubmitFailedEventDetails' => '

Contains details about a task that where the submit failed.

', ], ], 'TaskSubmittedEventDetails' => [ 'base' => '

Contains details about a task submitted to a resource .

', 'refs' => [ 'HistoryEvent$taskSubmittedEventDetails' => '

Contains details about a submitted task.

', ], ], 'TaskSucceededEventDetails' => [ 'base' => '

Contains details about the successful completion of a task state.

', 'refs' => [ 'HistoryEvent$taskSucceededEventDetails' => '

Contains details about a task that succeeded.

', ], ], 'TaskTimedOut' => [ 'base' => '

The task token has either expired or the task associated with the token has already been closed.

', 'refs' => [], ], 'TaskTimedOutEventDetails' => [ 'base' => '

Contains details about a resource timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$taskTimedOutEventDetails' => '

Contains details about a task that timed out.

', ], ], 'TaskToken' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$taskToken' => '

A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

', 'SendTaskFailureInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', 'SendTaskHeartbeatInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', 'SendTaskSuccessInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', ], ], 'TestExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'TestStateOutput$status' => '

The execution status of the state.

', ], ], 'TestStateInput' => [ 'base' => NULL, 'refs' => [], ], 'TestStateOutput' => [ 'base' => NULL, 'refs' => [], ], 'TimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the activity task.

', 'ActivityScheduledEventDetails$heartbeatInSeconds' => '

The maximum allowed duration between two heartbeats for the activity task.

', 'LambdaFunctionScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the Lambda function.

', 'TaskScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the task.

', 'TaskScheduledEventDetails$heartbeatInSeconds' => '

The maximum allowed duration between two heartbeats for the task.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$creationDate' => '

The date the activity is created.

', 'CreateActivityOutput$creationDate' => '

The date the activity is created.

', 'CreateStateMachineAliasOutput$creationDate' => '

The date the state machine alias was created.

', 'CreateStateMachineOutput$creationDate' => '

The date the state machine is created.

', 'DescribeActivityOutput$creationDate' => '

The date the activity is created.

', 'DescribeExecutionOutput$startDate' => '

The date the execution is started.

', 'DescribeExecutionOutput$stopDate' => '

If the execution ended, the date the execution stopped.

', 'DescribeExecutionOutput$redriveDate' => '

The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

', 'DescribeMapRunOutput$startDate' => '

The date when the Map Run was started.

', 'DescribeMapRunOutput$stopDate' => '

The date when the Map Run was stopped.

', 'DescribeMapRunOutput$redriveDate' => '

The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

', 'DescribeStateMachineAliasOutput$creationDate' => '

The date the state machine alias was created.

', 'DescribeStateMachineAliasOutput$updateDate' => '

The date the state machine alias was last updated.

For a newly created state machine, this is the same as the creation date.

', 'DescribeStateMachineForExecutionOutput$updateDate' => '

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

', 'DescribeStateMachineOutput$creationDate' => '

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

', 'ExecutionListItem$startDate' => '

The date the execution started.

', 'ExecutionListItem$stopDate' => '

If the execution already ended, the date the execution stopped.

', 'ExecutionListItem$redriveDate' => '

The date the execution was last redriven.

', 'HistoryEvent$timestamp' => '

The date and time the event occurred.

', 'MapRunListItem$startDate' => '

The date on which the Map Run started.

', 'MapRunListItem$stopDate' => '

The date on which the Map Run stopped.

', 'PublishStateMachineVersionOutput$creationDate' => '

The date the version was created.

', 'RedriveExecutionOutput$redriveDate' => '

The date the execution was last redriven.

', 'StartExecutionOutput$startDate' => '

The date the execution is started.

', 'StartSyncExecutionOutput$startDate' => '

The date the execution is started.

', 'StartSyncExecutionOutput$stopDate' => '

If the execution has already ended, the date the execution stopped.

', 'StateMachineAliasListItem$creationDate' => '

The creation date of a state machine alias.

', 'StateMachineListItem$creationDate' => '

The date the state machine is created.

', 'StateMachineVersionListItem$creationDate' => '

The creation date of a state machine version.

', 'StopExecutionOutput$stopDate' => '

The date the execution is stopped.

', 'UpdateStateMachineAliasOutput$updateDate' => '

The date and time the state machine alias was updated.

', 'UpdateStateMachineOutput$updateDate' => '

The date and time the state machine was updated.

', ], ], 'ToleratedFailureCount' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailureCount' => '

The maximum number of failed child workflow executions before the Map Run fails.

', 'UpdateMapRunInput$toleratedFailureCount' => '

The maximum number of failed items before the Map Run fails.

', ], ], 'ToleratedFailurePercentage' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailurePercentage' => '

The maximum percentage of failed child workflow executions before the Map Run fails.

', 'UpdateMapRunInput$toleratedFailurePercentage' => '

The maximum percentage of failed items before the Map Run fails.

', ], ], 'TooManyTags' => [ 'base' => '

You\'ve exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

', 'refs' => [], ], 'TraceHeader' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$traceHeader' => '

The X-Ray trace header that was passed to the execution.

', 'StartExecutionInput$traceHeader' => '

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

', 'StartSyncExecutionInput$traceHeader' => '

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

', 'StartSyncExecutionOutput$traceHeader' => '

The X-Ray trace header that was passed to the execution.

', ], ], 'TracingConfiguration' => [ 'base' => '

Selects whether or not the state machine\'s X-Ray tracing is enabled. Default is false

', 'refs' => [ 'CreateStateMachineInput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'DescribeStateMachineForExecutionOutput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'DescribeStateMachineOutput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'UpdateStateMachineInput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', ], ], 'URL' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$url' => '

The API endpoint used for the HTTP request.

', ], ], 'UnsignedInteger' => [ 'base' => NULL, 'refs' => [ 'ExecutionListItem$itemCount' => '

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn\'t returned.

', 'MapIterationEventDetails$index' => '

The index of the array belonging to the Map state iteration.

', 'MapStateStartedEventDetails$length' => '

The size of the array for Map state iterations.

', ], ], 'UnsignedLong' => [ 'base' => NULL, 'refs' => [ 'MapRunExecutionCounts$pending' => '

The total number of child workflow executions that were started by a Map Run, but haven\'t started executing yet.

', 'MapRunExecutionCounts$running' => '

The total number of child workflow executions that were started by a Map Run and are currently in-progress.

', 'MapRunExecutionCounts$succeeded' => '

The total number of child workflow executions that were started by a Map Run and have completed successfully.

', 'MapRunExecutionCounts$failed' => '

The total number of child workflow executions that were started by a Map Run, but have failed.

', 'MapRunExecutionCounts$timedOut' => '

The total number of child workflow executions that were started by a Map Run and have timed out.

', 'MapRunExecutionCounts$aborted' => '

The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.

', 'MapRunExecutionCounts$total' => '

The total number of child workflow executions that were started by a Map Run.

', 'MapRunExecutionCounts$resultsWritten' => '

Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

', 'MapRunItemCounts$pending' => '

The total number of items to process in child workflow executions that haven\'t started running yet.

', 'MapRunItemCounts$running' => '

The total number of items being processed in child workflow executions that are currently in-progress.

', 'MapRunItemCounts$succeeded' => '

The total number of items processed in child workflow executions that have completed successfully.

', 'MapRunItemCounts$failed' => '

The total number of items processed in child workflow executions that have failed.

', 'MapRunItemCounts$timedOut' => '

The total number of items processed in child workflow executions that have timed out.

', 'MapRunItemCounts$aborted' => '

The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

', 'MapRunItemCounts$total' => '

The total number of items processed in all the child workflow executions started by a Map Run.

', 'MapRunItemCounts$resultsWritten' => '

Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMapRunInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMapRunOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionCode' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$code' => '

Identifying code for the diagnostic.

', ], ], 'ValidateStateMachineDefinitionDiagnostic' => [ 'base' => '

Describes an error found during validation. Validation errors found in the definition return in the response as diagnostic elements, rather than raise an exception.

', 'refs' => [ 'ValidateStateMachineDefinitionDiagnosticList$member' => NULL, ], ], 'ValidateStateMachineDefinitionDiagnosticList' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionOutput$diagnostics' => '

If the result is OK, this field will be empty. When there are errors, this field will contain an array of Diagnostic objects to help you troubleshoot.

', ], ], 'ValidateStateMachineDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionLocation' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$location' => '

Location of the issue in the state machine, if available.

For errors specific to a field, the location could be in the format: /States/<StateName>/<FieldName>, for example: /States/FailState/ErrorPath.

', ], ], 'ValidateStateMachineDefinitionMessage' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$message' => '

Message describing the diagnostic condition.

', ], ], 'ValidateStateMachineDefinitionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionResultCode' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionOutput$result' => '

The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

', ], ], 'ValidateStateMachineDefinitionSeverity' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$severity' => '

A value of ERROR means that you cannot create or update a state machine with this definition.

', ], ], 'ValidationException' => [ 'base' => '

The input does not satisfy the constraints specified by an Amazon Web Services service.

', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

The input does not satisfy the constraints specified by an Amazon Web Services service.

', ], ], 'VersionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$versionDescription' => '

Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.

', 'DescribeStateMachineOutput$description' => '

The description of the state machine version.

', 'PublishStateMachineVersionInput$description' => '

An optional description of the state machine version.

', 'UpdateStateMachineInput$versionDescription' => '

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you\'ve set publish to true.

', ], ], 'VersionWeight' => [ 'base' => NULL, 'refs' => [ 'RoutingConfigurationListItem$weight' => '

The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.

', ], ], 'includedDetails' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEventsExecutionDataDetails$included' => '

Indicates whether input or output was included in the response. Always true for API calls.

', ], ], 'truncated' => [ 'base' => NULL, 'refs' => [ 'HistoryEventExecutionDataDetails$truncated' => '

Indicates whether input or output was truncated in the response. Always false for API calls.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Step Functions

Step Functions coordinates the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

', 'operations' => [ 'CreateActivity' => '

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity\'s idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'CreateStateMachine' => '

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine\'s idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

', 'CreateStateMachineAlias' => '

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client\'s code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

', 'DeleteActivity' => '

Deletes an activity.

', 'DeleteStateMachine' => '

Deletes a state machine. This is an asynchronous operation. It sets the state machine\'s status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine\'s executions are terminated.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

This API action also deletes all versions and aliases associated with a state machine.

For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

', 'DeleteStateMachineAlias' => '

Deletes a state machine alias.

After you delete a state machine alias, you can\'t use it to start executions. When you delete a state machine alias, Step Functions doesn\'t delete the state machine versions that alias references.

Related operations:

', 'DeleteStateMachineVersion' => '

Deletes a state machine version. After you delete a version, you can\'t call StartExecution using that version\'s ARN or use the version with a state machine alias.

Deleting a state machine version won\'t terminate its in-progress executions.

You can\'t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

Related operations:

', 'DescribeActivity' => '

Describes an activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'DescribeExecution' => '

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you\'ve redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Executions of an EXPRESS state machine aren\'t supported by DescribeExecution unless a Map Run dispatched them.

', 'DescribeMapRun' => '

Provides information about a Map Run\'s configuration, progress, and results. If you\'ve redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

', 'DescribeStateMachine' => '

Provides information about a state machine\'s definition, its IAM role Amazon Resource Name (ARN), and configuration.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'DescribeStateMachineAlias' => '

Returns details about a state machine alias.

Related operations:

', 'DescribeStateMachineForExecution' => '

Provides information about a state machine\'s definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

', 'GetActivityTask' => '

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

This API action isn\'t logged in CloudTrail.

Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

', 'GetExecutionHistory' => '

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

', 'ListActivities' => '

Lists the existing activities.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'ListExecutions' => '

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

Results are sorted by time, with the most recent execution first.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

', 'ListMapRuns' => '

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

', 'ListStateMachineAliases' => '

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

', 'ListStateMachineVersions' => '

Lists versions for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

', 'ListStateMachines' => '

Lists the existing state machines.

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

', 'ListTagsForResource' => '

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'PublishStateMachineVersion' => '

Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

PublishStateMachineVersion is an idempotent API. It doesn\'t create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion\'s idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don\'t specify a revisionId, Step Functions checks for a previously published version of the state machine\'s current revision.

Related operations:

', 'RedriveExecution' => '

Restarts unsuccessful executions of Standard workflows that didn\'t complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn\'t rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

This API action is not supported by EXPRESS state machines.

However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

You can redrive executions if your original execution meets the following conditions:

', 'SendTaskFailure' => '

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

', 'SendTaskHeartbeat' => '

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine\'s Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine\'s Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

', 'SendTaskSuccess' => '

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

', 'StartExecution' => '

Starts a state machine execution.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version.

StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

StartExecution isn\'t idempotent for EXPRESS workflows.

', 'StartSyncExecution' => '

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn\'t reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn\'t logged in CloudTrail.

', 'StopExecution' => '

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

', 'TagResource' => '

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'TestState' => '

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

You can call this API on only one state at a time. The states that you can test include the following:

The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.

TestState doesn\'t support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

', 'UntagResource' => '

Remove a tag from a Step Functions resource

', 'UpdateMapRun' => '

Updates an in-progress Map Run\'s configuration to include changes to the settings that control maximum concurrency and Map Run failure.

', 'UpdateStateMachine' => '

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

', 'UpdateStateMachineAlias' => '

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response.

This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.

Related operations:

', 'ValidateStateMachineDefinition' => '

Validates the syntax of a state machine definition.

You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke CreateStateMachine and UpdateStateMachine. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).

Suggested uses for ValidateStateMachineDefinition:

Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.

', ], 'shapes' => [ 'ActivityAlreadyExists' => [ 'base' => '

Activity already exists. EncryptionConfiguration may not be updated.

', 'refs' => [], ], 'ActivityDoesNotExist' => [ 'base' => '

The specified activity does not exist.

', 'refs' => [], ], 'ActivityFailedEventDetails' => [ 'base' => '

Contains details about an activity that failed during an execution.

', 'refs' => [ 'HistoryEvent$activityFailedEventDetails' => NULL, ], ], 'ActivityLimitExceeded' => [ 'base' => '

The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

', 'refs' => [], ], 'ActivityList' => [ 'base' => NULL, 'refs' => [ 'ListActivitiesOutput$activities' => '

The list of activities.

', ], ], 'ActivityListItem' => [ 'base' => '

Contains details about an activity.

', 'refs' => [ 'ActivityList$member' => NULL, ], ], 'ActivityScheduleFailedEventDetails' => [ 'base' => '

Contains details about an activity schedule failure that occurred during an execution.

', 'refs' => [ 'HistoryEvent$activityScheduleFailedEventDetails' => '

Contains details about an activity schedule event that failed during an execution.

', ], ], 'ActivityScheduledEventDetails' => [ 'base' => '

Contains details about an activity scheduled during an execution.

', 'refs' => [ 'HistoryEvent$activityScheduledEventDetails' => NULL, ], ], 'ActivityStartedEventDetails' => [ 'base' => '

Contains details about the start of an activity during an execution.

', 'refs' => [ 'HistoryEvent$activityStartedEventDetails' => NULL, ], ], 'ActivitySucceededEventDetails' => [ 'base' => '

Contains details about an activity that successfully terminated during an execution.

', 'refs' => [ 'HistoryEvent$activitySucceededEventDetails' => NULL, ], ], 'ActivityTimedOutEventDetails' => [ 'base' => '

Contains details about an activity timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$activityTimedOutEventDetails' => NULL, ], ], 'ActivityWorkerLimitExceeded' => [ 'base' => '

The maximum number of workers concurrently polling for activity tasks has been reached.

', 'refs' => [], ], 'AliasDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$description' => '

A description for the state machine alias.

', 'DescribeStateMachineAliasOutput$description' => '

A description of the alias.

', 'UpdateStateMachineAliasInput$description' => '

A description of the state machine alias.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$activityArn' => '

The Amazon Resource Name (ARN) that identifies the activity.

', 'ActivityScheduledEventDetails$resource' => '

The Amazon Resource Name (ARN) of the scheduled activity.

', 'CloudWatchLogsLogGroup$logGroupArn' => '

The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

', 'CreateActivityOutput$activityArn' => '

The Amazon Resource Name (ARN) that identifies the created activity.

', 'CreateStateMachineAliasOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine alias.

', 'CreateStateMachineInput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

', 'CreateStateMachineOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine.

', 'CreateStateMachineOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.

', 'DeleteActivityInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to delete.

', 'DeleteStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias to delete.

', 'DeleteStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to delete.

', 'DescribeActivityInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to describe.

', 'DescribeActivityOutput$activityArn' => '

The Amazon Resource Name (ARN) that identifies the activity.

', 'DescribeExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to describe.

', 'DescribeExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'DescribeExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the executed stated machine.

', 'DescribeExecutionOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

', 'DescribeExecutionOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

', 'DescribeMapRunOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

', 'DescribeStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'DescribeStateMachineAliasOutput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'DescribeStateMachineForExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution you want state machine information for.

', 'DescribeStateMachineForExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine associated with the execution.

', 'DescribeStateMachineForExecutionOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

', 'DescribeStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine for which you want the information.

If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'DescribeStateMachineOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'DescribeStateMachineOutput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

', 'ExecutionListItem$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'ExecutionListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine that ran the execution.

', 'ExecutionListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version associated with the execution.

If the state machine execution was started with an unqualified ARN, it returns null.

If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

', 'ExecutionListItem$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

', 'ExecutionStartedEventDetails$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.

', 'ExecutionStartedEventDetails$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.

', 'ExecutionStartedEventDetails$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.

', 'GetActivityTaskInput$activityArn' => '

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

', 'GetExecutionHistoryInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution.

', 'LambdaFunctionScheduledEventDetails$resource' => '

The Amazon Resource Name (ARN) of the scheduled Lambda function.

', 'ListExecutionsInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

', 'ListMapRunsInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

', 'ListStateMachineAliasesInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

If you specify a state machine version ARN, this API returns a list of aliases for that version.

', 'ListStateMachineVersionsInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'ListTagsForResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'MapRunListItem$executionArn' => '

The executionArn of the execution from which the Map Run was started.

', 'MapRunListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) of the executed state machine.

', 'PublishStateMachineVersionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'PublishStateMachineVersionOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.

', 'RedriveExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to be redriven.

', 'ResourceNotFound$resourceName' => NULL, 'RoutingConfigurationListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.

If you specify the ARN of a second version, it must belong to the same state machine as the first version.

', 'StartExecutionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to execute.

The stateMachineArn parameter accepts one of the following inputs:

', 'StartExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'StartSyncExecutionInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine to execute.

', 'StartSyncExecutionOutput$executionArn' => '

The Amazon Resource Name (ARN) that identifies the execution.

', 'StartSyncExecutionOutput$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

', 'StateMachineListItem$stateMachineArn' => '

The Amazon Resource Name (ARN) that identifies the state machine.

', 'StopExecutionInput$executionArn' => '

The Amazon Resource Name (ARN) of the execution to stop.

', 'TagResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'TestStateInput$roleArn' => '

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

', 'TooManyTags$resourceName' => NULL, 'UntagResourceInput$resourceArn' => '

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

', 'UpdateStateMachineAliasInput$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) of the state machine alias.

', 'UpdateStateMachineInput$stateMachineArn' => '

The Amazon Resource Name (ARN) of the state machine.

', 'UpdateStateMachineInput$roleArn' => '

The Amazon Resource Name (ARN) of the IAM role of the state machine.

', 'UpdateStateMachineOutput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the published state machine version.

If the publish parameter isn\'t set to true, this field returns null.

', ], ], 'BilledDuration' => [ 'base' => NULL, 'refs' => [ 'BillingDetails$billedDurationInMilliseconds' => '

Billed duration of your workflow, in milliseconds.

', ], ], 'BilledMemoryUsed' => [ 'base' => NULL, 'refs' => [ 'BillingDetails$billedMemoryUsedInMB' => '

Billed memory consumption of your workflow, in MB.

', ], ], 'BillingDetails' => [ 'base' => '

An object that describes workflow billing details.

', 'refs' => [ 'StartSyncExecutionOutput$billingDetails' => '

An object that describes workflow billing details, including billed duration and memory use.

', ], ], 'CharacterRestrictedName' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$name' => '

The name of the state machine alias.

To avoid conflict with version ARNs, don\'t use an integer in the name of the alias.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'RedriveExecutionInput$clientToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.

', ], ], 'CloudWatchEventsExecutionDataDetails' => [ 'base' => '

Provides details about execution input or output.

', 'refs' => [ 'DescribeExecutionOutput$inputDetails' => NULL, 'DescribeExecutionOutput$outputDetails' => NULL, 'StartSyncExecutionOutput$inputDetails' => NULL, 'StartSyncExecutionOutput$outputDetails' => NULL, ], ], 'CloudWatchLogsLogGroup' => [ 'base' => '

', 'refs' => [ 'LogDestination$cloudWatchLogsLogGroup' => '

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

', ], ], 'ConflictException' => [ 'base' => '

Updating or deleting a resource can cause an inconsistent state. This error occurs when there\'re concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

HTTP Status Code: 409

', 'refs' => [], ], 'ConnectorParameters' => [ 'base' => NULL, 'refs' => [ 'TaskScheduledEventDetails$parameters' => '

The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'CreateActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Definition' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'DescribeStateMachineForExecutionOutput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'DescribeStateMachineOutput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

If called with includedData = METADATA_ONLY, the returned definition will be {}.

', 'TestStateInput$definition' => '

The Amazon States Language (ASL) definition of the state.

', 'UpdateStateMachineInput$definition' => '

The Amazon States Language definition of the state machine. See Amazon States Language.

', 'ValidateStateMachineDefinitionInput$definition' => '

The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).

', ], ], 'DeleteActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStateMachineVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActivityOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMapRunOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineForExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'TracingConfiguration$enabled' => '

When set to true, X-Ray tracing is enabled.

', ], ], 'EncryptionConfiguration' => [ 'base' => '

Settings to configure server-side encryption.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines and activities. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine, and when creating an Activity. The execution history and state machine definition will be encrypted with the key applied to the State Machine. Activity inputs will be encrypted with the key applied to the Activity.

Step Functions automatically enables encryption at rest using Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see Key Management Service pricing.

For more information on KMS, see What is Key Management Service?

', 'refs' => [ 'CreateActivityInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'CreateStateMachineInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'DescribeActivityOutput$encryptionConfiguration' => '

Settings for configured server-side encryption.

', 'DescribeStateMachineForExecutionOutput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'DescribeStateMachineOutput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', 'UpdateStateMachineInput$encryptionConfiguration' => '

Settings to configure server-side encryption.

', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$type' => '

Encryption type

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ActivityAlreadyExists$message' => NULL, 'ActivityDoesNotExist$message' => NULL, 'ActivityLimitExceeded$message' => NULL, 'ActivityWorkerLimitExceeded$message' => NULL, 'ConflictException$message' => NULL, 'ExecutionAlreadyExists$message' => NULL, 'ExecutionDoesNotExist$message' => NULL, 'ExecutionLimitExceeded$message' => NULL, 'ExecutionNotRedrivable$message' => NULL, 'InvalidArn$message' => NULL, 'InvalidDefinition$message' => NULL, 'InvalidEncryptionConfiguration$message' => NULL, 'InvalidExecutionInput$message' => NULL, 'InvalidLoggingConfiguration$message' => NULL, 'InvalidName$message' => NULL, 'InvalidOutput$message' => NULL, 'InvalidToken$message' => NULL, 'InvalidTracingConfiguration$message' => NULL, 'KmsAccessDeniedException$message' => NULL, 'KmsInvalidStateException$message' => NULL, 'KmsThrottlingException$message' => NULL, 'MissingRequiredParameter$message' => NULL, 'ResourceNotFound$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'StateMachineAlreadyExists$message' => NULL, 'StateMachineDeleting$message' => NULL, 'StateMachineDoesNotExist$message' => NULL, 'StateMachineLimitExceeded$message' => NULL, 'StateMachineTypeNotSupported$message' => NULL, 'TaskDoesNotExist$message' => NULL, 'TaskTimedOut$message' => NULL, 'TooManyTags$message' => NULL, 'ValidationException$message' => NULL, ], ], 'EventId' => [ 'base' => NULL, 'refs' => [ 'HistoryEvent$id' => '

The id of the event. Events are numbered sequentially, starting at one.

', 'HistoryEvent$previousEventId' => '

The id of the previous event.

', ], ], 'ExecutionAbortedEventDetails' => [ 'base' => '

Contains details about an abort of an execution.

', 'refs' => [ 'HistoryEvent$executionAbortedEventDetails' => NULL, ], ], 'ExecutionAlreadyExists' => [ 'base' => '

The execution has the same name as another execution (but a different input).

Executions with the same name and input are considered idempotent.

', 'refs' => [], ], 'ExecutionDoesNotExist' => [ 'base' => '

The specified execution does not exist.

', 'refs' => [], ], 'ExecutionFailedEventDetails' => [ 'base' => '

Contains details about an execution failure event.

', 'refs' => [ 'HistoryEvent$executionFailedEventDetails' => NULL, ], ], 'ExecutionLimitExceeded' => [ 'base' => '

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

', 'refs' => [], ], 'ExecutionList' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsOutput$executions' => '

The list of matching executions.

', ], ], 'ExecutionListItem' => [ 'base' => '

Contains details about an execution.

', 'refs' => [ 'ExecutionList$member' => NULL, ], ], 'ExecutionNotRedrivable' => [ 'base' => '

The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.

', 'refs' => [], ], 'ExecutionRedriveFilter' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsInput$redriveFilter' => '

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

', ], ], 'ExecutionRedriveStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$redriveStatus' => '

Indicates whether or not an execution can be redriven at a given point in time.

', ], ], 'ExecutionRedrivenEventDetails' => [ 'base' => '

Contains details about a redriven execution.

', 'refs' => [ 'HistoryEvent$executionRedrivenEventDetails' => '

Contains details about the redrive attempt of an execution.

', ], ], 'ExecutionStartedEventDetails' => [ 'base' => '

Contains details about the start of the execution.

', 'refs' => [ 'HistoryEvent$executionStartedEventDetails' => NULL, ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$status' => '

The current status of the execution.

', 'ExecutionListItem$status' => '

The current status of the execution.

', 'ListExecutionsInput$statusFilter' => '

If specified, only list the executions whose current execution status matches the given filter.

', ], ], 'ExecutionSucceededEventDetails' => [ 'base' => '

Contains details about the successful termination of the execution.

', 'refs' => [ 'HistoryEvent$executionSucceededEventDetails' => NULL, ], ], 'ExecutionTimedOutEventDetails' => [ 'base' => '

Contains details about the execution timeout that occurred during the execution.

', 'refs' => [ 'HistoryEvent$executionTimedOutEventDetails' => NULL, ], ], 'GetActivityTaskInput' => [ 'base' => NULL, 'refs' => [], ], 'GetActivityTaskOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetExecutionHistoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'HTTPBody' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$body' => '

The request body for the HTTP request.

', 'InspectionDataResponse$body' => '

The HTTP response returned.

', ], ], 'HTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$headers' => '

The request headers associated with the HTTP request.

', 'InspectionDataResponse$headers' => '

The response headers associated with the HTTP response.

', ], ], 'HTTPMethod' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$method' => '

The HTTP method used for the HTTP request.

', ], ], 'HTTPProtocol' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$protocol' => '

The protocol used to make the HTTP request.

', 'InspectionDataResponse$protocol' => '

The protocol used to return the HTTP response.

', ], ], 'HTTPStatusCode' => [ 'base' => NULL, 'refs' => [ 'InspectionDataResponse$statusCode' => '

The HTTP response status code for the HTTP response.

', ], ], 'HTTPStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InspectionDataResponse$statusMessage' => '

The message associated with the HTTP status code.

', ], ], 'HistoryEvent' => [ 'base' => '

Contains details about the events of an execution.

', 'refs' => [ 'HistoryEventList$member' => NULL, ], ], 'HistoryEventExecutionDataDetails' => [ 'base' => '

Provides details about input or output in an execution history event.

', 'refs' => [ 'ActivityScheduledEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'ActivitySucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'ExecutionStartedEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'ExecutionSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'LambdaFunctionScheduledEventDetails$inputDetails' => '

Contains details about input for an execution history event.

', 'LambdaFunctionSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'StateEnteredEventDetails$inputDetails' => '

Contains details about the input for an execution history event.

', 'StateExitedEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'TaskSubmittedEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', 'TaskSucceededEventDetails$outputDetails' => '

Contains details about the output of an execution history event.

', ], ], 'HistoryEventList' => [ 'base' => '

Contains details about the events that occurred during an execution.

', 'refs' => [ 'GetExecutionHistoryOutput$events' => '

The list of events that occurred in the execution.

', ], ], 'HistoryEventType' => [ 'base' => NULL, 'refs' => [ 'HistoryEvent$type' => '

The type of the event.

', ], ], 'Identity' => [ 'base' => NULL, 'refs' => [ 'ActivityStartedEventDetails$workerName' => '

The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.

', ], ], 'IncludeExecutionData' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$includeExecutionData' => '

Determines whether execution data is included in your log. When set to false, data is excluded.

', ], ], 'IncludeExecutionDataGetExecutionHistory' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$includeExecutionData' => '

You can select whether execution data (input or output of a history event) is returned. The default is true.

', ], ], 'IncludedData' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call DescribeStateMachine API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', 'DescribeStateMachineForExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', 'DescribeStateMachineInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

', 'StartSyncExecutionInput$includedData' => '

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

', ], ], 'InspectionData' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP request and response information.

', 'refs' => [ 'TestStateOutput$inspectionData' => '

Returns additional details about the state\'s execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.

', ], ], 'InspectionDataRequest' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP request information.

', 'refs' => [ 'InspectionData$request' => '

The raw HTTP request that is sent when you test an HTTP Task.

', ], ], 'InspectionDataResponse' => [ 'base' => '

Contains additional details about the state\'s execution, including its input and output data processing flow, and HTTP response information. The inspectionLevel request parameter specifies which details are returned.

', 'refs' => [ 'InspectionData$response' => '

The raw HTTP response that is returned when you test an HTTP Task.

', ], ], 'InspectionLevel' => [ 'base' => NULL, 'refs' => [ 'TestStateInput$inspectionLevel' => '

Determines the values to return when a state is tested. You can specify one of the following types:

Each of these levels also provide information about the status of the state execution and the next state to transition to.

', ], ], 'InvalidArn' => [ 'base' => '

The provided Amazon Resource Name (ARN) is not valid.

', 'refs' => [], ], 'InvalidDefinition' => [ 'base' => '

The provided Amazon States Language definition is not valid.

', 'refs' => [], ], 'InvalidEncryptionConfiguration' => [ 'base' => '

Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.

', 'refs' => [], ], 'InvalidExecutionInput' => [ 'base' => '

The provided JSON input data is not valid.

', 'refs' => [], ], 'InvalidLoggingConfiguration' => [ 'base' => '

Configuration is not valid.

', 'refs' => [], ], 'InvalidName' => [ 'base' => '

The provided name is not valid.

', 'refs' => [], ], 'InvalidOutput' => [ 'base' => '

The provided JSON output data is not valid.

', 'refs' => [], ], 'InvalidToken' => [ 'base' => '

The provided token is not valid.

', 'refs' => [], ], 'InvalidTracingConfiguration' => [ 'base' => '

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

', 'refs' => [], ], 'KmsAccessDeniedException' => [ 'base' => '

Either your KMS key policy or API caller does not have the required permissions.

', 'refs' => [], ], 'KmsDataKeyReusePeriodSeconds' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsDataKeyReusePeriodSeconds' => '

Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.

', ], ], 'KmsInvalidStateException' => [ 'base' => '

The KMS key is not in valid state, for example: Disabled or Deleted.

', 'refs' => [], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyId' => '

An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

', ], ], 'KmsKeyState' => [ 'base' => NULL, 'refs' => [ 'KmsInvalidStateException$kmsKeyState' => '

Current status of the KMS; key. For example: DISABLED, PENDING_DELETION, PENDING_IMPORT, UNAVAILABLE, CREATING.

', ], ], 'KmsThrottlingException' => [ 'base' => '

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

', 'refs' => [], ], 'LambdaFunctionFailedEventDetails' => [ 'base' => '

Contains details about a Lambda function that failed during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduleFailedEventDetails' => [ 'base' => '

Contains details about a failed Lambda function schedule event that occurred during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduleFailedEventDetails' => NULL, ], ], 'LambdaFunctionScheduledEventDetails' => [ 'base' => '

Contains details about a Lambda function scheduled during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionScheduledEventDetails' => NULL, ], ], 'LambdaFunctionStartFailedEventDetails' => [ 'base' => '

Contains details about a lambda function that failed to start during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionStartFailedEventDetails' => '

Contains details about a lambda function that failed to start during an execution.

', ], ], 'LambdaFunctionSucceededEventDetails' => [ 'base' => '

Contains details about a Lambda function that successfully terminated during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionSucceededEventDetails' => '

Contains details about a Lambda function that terminated successfully during an execution.

', ], ], 'LambdaFunctionTimedOutEventDetails' => [ 'base' => '

Contains details about a Lambda function timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$lambdaFunctionTimedOutEventDetails' => NULL, ], ], 'ListActivitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListActivitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExecutionsPageToken' => [ 'base' => NULL, 'refs' => [ 'ListExecutionsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListExecutionsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', ], ], 'ListMapRunsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListMapRunsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineAliasesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineAliasesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachineVersionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachinesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStateMachinesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogDestination' => [ 'base' => '

', 'refs' => [ 'LogDestinationList$member' => NULL, ], ], 'LogDestinationList' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$destinations' => '

An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.

', ], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$level' => '

Defines which category of execution history events are logged.

', ], ], 'LoggingConfiguration' => [ 'base' => '

The LoggingConfiguration data type is used to set CloudWatch Logs options.

', 'refs' => [ 'CreateStateMachineInput$loggingConfiguration' => '

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

', 'DescribeStateMachineForExecutionOutput$loggingConfiguration' => NULL, 'DescribeStateMachineOutput$loggingConfiguration' => NULL, 'UpdateStateMachineInput$loggingConfiguration' => '

Use the LoggingConfiguration data type to set CloudWatch Logs options.

', ], ], 'LongArn' => [ 'base' => NULL, 'refs' => [ 'DeleteStateMachineVersionInput$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) of the state machine version to delete.

', 'DescribeExecutionOutput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

', 'DescribeMapRunInput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run.

', 'DescribeMapRunOutput$mapRunArn' => '

The Amazon Resource Name (ARN) that identifies a Map Run.

', 'DescribeStateMachineForExecutionOutput$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

', 'ExecutionListItem$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn\'t returned.

', 'ListExecutionsInput$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

', 'MapRunListItem$mapRunArn' => '

The Amazon Resource Name (ARN) of the Map Run.

', 'MapRunRedrivenEventDetails$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run that was redriven.

', 'MapRunStartedEventDetails$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run that was started.

', 'StateMachineAliasListItem$stateMachineAliasArn' => '

The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

', 'StateMachineVersionListItem$stateMachineVersionArn' => '

The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

', 'TaskCredentials$roleArn' => '

The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.

', 'UpdateMapRunInput$mapRunArn' => '

The Amazon Resource Name (ARN) of a Map Run.

', ], ], 'LongObject' => [ 'base' => NULL, 'refs' => [ 'MapRunExecutionCounts$failuresNotRedrivable' => '

The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

', 'MapRunExecutionCounts$pendingRedrive' => '

The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.

', 'MapRunItemCounts$failuresNotRedrivable' => '

The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

', 'MapRunItemCounts$pendingRedrive' => '

The number of unsuccessful items in child workflow executions currently waiting to be redriven.

', ], ], 'MapIterationEventDetails' => [ 'base' => '

Contains details about an iteration of a Map state.

', 'refs' => [ 'HistoryEvent$mapIterationStartedEventDetails' => '

Contains details about an iteration of a Map state that was started.

', 'HistoryEvent$mapIterationSucceededEventDetails' => '

Contains details about an iteration of a Map state that succeeded.

', 'HistoryEvent$mapIterationFailedEventDetails' => '

Contains details about an iteration of a Map state that failed.

', 'HistoryEvent$mapIterationAbortedEventDetails' => '

Contains details about an iteration of a Map state that was aborted.

', ], ], 'MapRunExecutionCounts' => [ 'base' => '

Contains details about all of the child workflow executions started by a Map Run.

', 'refs' => [ 'DescribeMapRunOutput$executionCounts' => '

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

', ], ], 'MapRunFailedEventDetails' => [ 'base' => '

Contains details about a Map Run failure event that occurred during a state machine execution.

', 'refs' => [ 'HistoryEvent$mapRunFailedEventDetails' => '

Contains error and cause details about a Map Run that failed.

', ], ], 'MapRunItemCounts' => [ 'base' => '

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

', 'refs' => [ 'DescribeMapRunOutput$itemCounts' => '

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

', ], ], 'MapRunLabel' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineForExecutionOutput$label' => '

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

', 'DescribeStateMachineOutput$label' => '

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

', ], ], 'MapRunList' => [ 'base' => NULL, 'refs' => [ 'ListMapRunsOutput$mapRuns' => '

An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

', ], ], 'MapRunListItem' => [ 'base' => '

Contains details about a specific Map Run.

', 'refs' => [ 'MapRunList$member' => NULL, ], ], 'MapRunRedrivenEventDetails' => [ 'base' => '

Contains details about a Map Run that was redriven.

', 'refs' => [ 'HistoryEvent$mapRunRedrivenEventDetails' => '

Contains details about the redrive attempt of a Map Run.

', ], ], 'MapRunStartedEventDetails' => [ 'base' => '

Contains details about a Map Run that was started during a state machine execution.

', 'refs' => [ 'HistoryEvent$mapRunStartedEventDetails' => '

Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.

', ], ], 'MapRunStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$status' => '

The current status of the Map Run.

', ], ], 'MapStateStartedEventDetails' => [ 'base' => '

Details about a Map state that was started.

', 'refs' => [ 'HistoryEvent$mapStateStartedEventDetails' => '

Contains details about Map state that was started.

', ], ], 'MaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$maxConcurrency' => '

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

', 'UpdateMapRunInput$maxConcurrency' => '

The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.

', ], ], 'MissingRequiredParameter' => [ 'base' => '

Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

', 'refs' => [], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$name' => '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'CreateActivityInput$name' => '

The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'CreateStateMachineInput$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeActivityOutput$name' => '

The name of the activity.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeExecutionOutput$name' => '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'DescribeStateMachineAliasOutput$name' => '

The name of the state machine alias.

', 'DescribeStateMachineForExecutionOutput$name' => '

The name of the state machine associated with the execution.

', 'DescribeStateMachineOutput$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'ExecutionListItem$name' => '

The name of the execution.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'GetActivityTaskInput$workerName' => '

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

', 'MapIterationEventDetails$name' => '

The name of the iteration’s parent Map state.

', 'StartExecutionInput$name' => '

Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

If you don\'t provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'StartSyncExecutionInput$name' => '

The name of the execution.

', 'StartSyncExecutionOutput$name' => '

The name of the execution.

', 'StateEnteredEventDetails$name' => '

The name of the state.

', 'StateExitedEventDetails$name' => '

The name of the state.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'StateMachineListItem$name' => '

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

', 'TaskFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskScheduledEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskScheduledEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskScheduledEventDetails$region' => '

The region of the scheduled task

', 'TaskStartFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskStartFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskStartedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskStartedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSubmitFailedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSubmitFailedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSubmittedEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSubmittedEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskSucceededEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskSucceededEventDetails$resource' => '

The action of the resource called by a task state.

', 'TaskTimedOutEventDetails$resourceType' => '

The service name of the resource in a task state.

', 'TaskTimedOutEventDetails$resource' => '

The action of the resource called by a task state.

', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListActivitiesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListExecutionsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListMapRunsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachineAliasesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachineVersionsInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', 'ListStateMachinesInput$maxResults' => '

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'GetExecutionHistoryOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListActivitiesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListActivitiesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListMapRunsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListMapRunsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineAliasesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineAliasesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineVersionsInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachineVersionsOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachinesInput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', 'ListStateMachinesOutput$nextToken' => '

If 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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

', ], ], 'Publish' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$publish' => '

Set to true to publish the first version of the state machine during creation. The default is false.

', 'UpdateStateMachineInput$publish' => '

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

', ], ], 'PublishStateMachineVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'PublishStateMachineVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'RedriveCount' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

', 'DescribeMapRunOutput$redriveCount' => '

The number of times you\'ve redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.

', 'ExecutionListItem$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

', 'ExecutionRedrivenEventDetails$redriveCount' => '

The number of times you\'ve redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

', 'MapRunRedrivenEventDetails$redriveCount' => '

The number of times the Map Run has been redriven at this point in the execution\'s history including this event. The redrive count for a redriven Map Run is always greater than 0.

', ], ], 'RedriveExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'RedriveExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFound' => [ 'base' => '

Could not find the referenced resource.

', 'refs' => [], ], 'RevealSecrets' => [ 'base' => NULL, 'refs' => [ 'TestStateInput$revealSecrets' => '

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn\'t omit any information included in the state definition or the HTTP response.

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

By default, revealSecrets is set to false.

', ], ], 'ReverseOrder' => [ 'base' => NULL, 'refs' => [ 'GetExecutionHistoryInput$reverseOrder' => '

Lists events in descending order of their timeStamp.

', ], ], 'RevisionId' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineForExecutionOutput$revisionId' => '

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

', 'DescribeStateMachineOutput$revisionId' => '

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

', 'PublishStateMachineVersionInput$revisionId' => '

Only publish the state machine version if the current state machine\'s revision ID matches the specified ID.

Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn\'t match the state machine\'s current revision ID, the API returns ConflictException.

To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.

', 'UpdateStateMachineOutput$revisionId' => '

The revision identifier for the updated state machine.

', ], ], 'RoutingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineAliasInput$routingConfiguration' => '

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.

', 'DescribeStateMachineAliasOutput$routingConfiguration' => '

The routing configuration of the alias.

', 'UpdateStateMachineAliasInput$routingConfiguration' => '

The routing configuration of the state machine alias.

An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.

', ], ], 'RoutingConfigurationListItem' => [ 'base' => '

Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.

', 'refs' => [ 'RoutingConfigurationList$member' => NULL, ], ], 'SendTaskFailureInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskFailureOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskHeartbeatOutput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessInput' => [ 'base' => NULL, 'refs' => [], ], 'SendTaskSuccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveCause' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ActivityScheduleFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ActivityTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'DescribeExecutionOutput$cause' => '

The cause string if the state machine execution failed.

', 'ExecutionAbortedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ExecutionFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'ExecutionTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'LambdaFunctionFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionScheduleFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionStartFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'LambdaFunctionTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the timeout.

', 'MapRunFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'SendTaskFailureInput$cause' => '

A more detailed explanation of the cause of the failure.

', 'StartSyncExecutionOutput$cause' => '

A more detailed explanation of the cause of the failure.

', 'StopExecutionInput$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskStartFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskSubmitFailedEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TaskTimedOutEventDetails$cause' => '

A more detailed explanation of the cause of the failure.

', 'TestStateOutput$cause' => '

A detailed explanation of the cause for the error when the execution of a state fails.

', ], ], 'SensitiveData' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$input' => '

The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'ActivitySucceededEventDetails$output' => '

The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'DescribeExecutionOutput$input' => '

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'DescribeExecutionOutput$output' => '

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

', 'DescribeExecutionOutput$redriveStatusReason' => '

When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

', 'ExecutionStartedEventDetails$input' => '

The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'ExecutionSucceededEventDetails$output' => '

The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'InspectionData$input' => '

The raw state input.

', 'InspectionData$afterInputPath' => '

The input after Step Functions applies the InputPath filter.

', 'InspectionData$afterParameters' => '

The effective input after Step Functions applies the Parameters filter.

', 'InspectionData$result' => '

The state\'s raw result.

', 'InspectionData$afterResultSelector' => '

The effective result after Step Functions applies the ResultSelector filter.

', 'InspectionData$afterResultPath' => '

The effective result combined with the raw state input after Step Functions applies the ResultPath filter.

', 'LambdaFunctionScheduledEventDetails$input' => '

The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'LambdaFunctionSucceededEventDetails$output' => '

The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'SendTaskSuccessInput$output' => '

The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartExecutionInput$input' => '

The string that contains the JSON input data for the execution, for example:

"input": "{\\"first_name\\" : \\"test\\"}"

If you don\'t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionInput$input' => '

The string that contains the JSON input data for the execution, for example:

"input": "{\\"first_name\\" : \\"test\\"}"

If you don\'t include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionOutput$input' => '

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StartSyncExecutionOutput$output' => '

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

', 'StateEnteredEventDetails$input' => '

The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'StateExitedEventDetails$output' => '

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TaskSubmittedEventDetails$output' => '

The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TaskSucceededEventDetails$output' => '

The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', 'TestStateInput$input' => '

A string that contains the JSON input data for the state.

', 'TestStateOutput$output' => '

The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'SensitiveDataJobInput' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$input' => '

The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

', ], ], 'SensitiveError' => [ 'base' => NULL, 'refs' => [ 'ActivityFailedEventDetails$error' => '

The error code of the failure.

', 'ActivityScheduleFailedEventDetails$error' => '

The error code of the failure.

', 'ActivityTimedOutEventDetails$error' => '

The error code of the failure.

', 'DescribeExecutionOutput$error' => '

The error string if the state machine execution failed.

', 'ExecutionAbortedEventDetails$error' => '

The error code of the failure.

', 'ExecutionFailedEventDetails$error' => '

The error code of the failure.

', 'ExecutionTimedOutEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionScheduleFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionStartFailedEventDetails$error' => '

The error code of the failure.

', 'LambdaFunctionTimedOutEventDetails$error' => '

The error code of the failure.

', 'MapRunFailedEventDetails$error' => '

The error code of the Map Run failure.

', 'SendTaskFailureInput$error' => '

The error code of the failure.

', 'StartSyncExecutionOutput$error' => '

The error code of the failure.

', 'StopExecutionInput$error' => '

The error code of the failure.

', 'TaskFailedEventDetails$error' => '

The error code of the failure.

', 'TaskStartFailedEventDetails$error' => '

The error code of the failure.

', 'TaskSubmitFailedEventDetails$error' => '

The error code of the failure.

', 'TaskTimedOutEventDetails$error' => '

The error code of the failure.

', 'TestStateOutput$error' => '

The error returned when the execution of a state fails.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

', 'refs' => [], ], 'StartExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartSyncExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StateEnteredEventDetails' => [ 'base' => '

Contains details about a state entered during an execution.

', 'refs' => [ 'HistoryEvent$stateEnteredEventDetails' => NULL, ], ], 'StateExitedEventDetails' => [ 'base' => '

Contains details about an exit from a state during an execution.

', 'refs' => [ 'HistoryEvent$stateExitedEventDetails' => NULL, ], ], 'StateMachineAliasList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachineAliasesOutput$stateMachineAliases' => '

Aliases for the state machine.

', ], ], 'StateMachineAliasListItem' => [ 'base' => '

Contains details about a specific state machine alias.

', 'refs' => [ 'StateMachineAliasList$member' => NULL, ], ], 'StateMachineAlreadyExists' => [ 'base' => '

A state machine with the same name but a different definition or role ARN already exists.

', 'refs' => [], ], 'StateMachineDeleting' => [ 'base' => '

The specified state machine is being deleted.

', 'refs' => [], ], 'StateMachineDoesNotExist' => [ 'base' => '

The specified state machine does not exist.

', 'refs' => [], ], 'StateMachineLimitExceeded' => [ 'base' => '

The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

', 'refs' => [], ], 'StateMachineList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachinesOutput$stateMachines' => NULL, ], ], 'StateMachineListItem' => [ 'base' => '

Contains details about the state machine.

', 'refs' => [ 'StateMachineList$member' => NULL, ], ], 'StateMachineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStateMachineOutput$status' => '

The current status of the state machine.

', ], ], 'StateMachineType' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$type' => '

Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

', 'DescribeStateMachineOutput$type' => '

The type of the state machine (STANDARD or EXPRESS).

', 'StateMachineListItem$type' => '

', 'ValidateStateMachineDefinitionInput$type' => '

The target type of state machine for this definition. The default is STANDARD.

', ], ], 'StateMachineTypeNotSupported' => [ 'base' => '

State machine type is not supported.

', 'refs' => [], ], 'StateMachineVersionList' => [ 'base' => NULL, 'refs' => [ 'ListStateMachineVersionsOutput$stateMachineVersions' => '

Versions for the state machine.

', ], ], 'StateMachineVersionListItem' => [ 'base' => '

Contains details about a specific state machine version.

', 'refs' => [ 'StateMachineVersionList$member' => NULL, ], ], 'StateName' => [ 'base' => NULL, 'refs' => [ 'TestStateOutput$nextState' => '

The name of the next state to transition to. If you haven\'t defined a next state in your definition or if the execution of the state fails, this field doesn\'t contain a value.

', ], ], 'StopExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StopExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'SyncExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'StartSyncExecutionOutput$status' => '

The current status of the execution.

', ], ], 'Tag' => [ 'base' => '

Tags are key-value pairs that can be associated with Step Functions state machines and activities.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key of a tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => '

The list of tags to remove from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateActivityInput$tags' => '

The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'CreateStateMachineInput$tags' => '

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', 'ListTagsForResourceOutput$tags' => '

An array of tags associated with the resource.

', 'TagResourceInput$tags' => '

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value of a tag.

', ], ], 'TaskCredentials' => [ 'base' => '

Contains details about the credentials that Step Functions uses for a task.

', 'refs' => [ 'LambdaFunctionScheduledEventDetails$taskCredentials' => '

The credentials that Step Functions uses for the task.

', 'TaskScheduledEventDetails$taskCredentials' => '

The credentials that Step Functions uses for the task.

', ], ], 'TaskDoesNotExist' => [ 'base' => '

The activity does not exist.

', 'refs' => [], ], 'TaskFailedEventDetails' => [ 'base' => '

Contains details about a task failure event.

', 'refs' => [ 'HistoryEvent$taskFailedEventDetails' => '

Contains details about the failure of a task.

', ], ], 'TaskScheduledEventDetails' => [ 'base' => '

Contains details about a task scheduled during an execution.

', 'refs' => [ 'HistoryEvent$taskScheduledEventDetails' => '

Contains details about a task that was scheduled.

', ], ], 'TaskStartFailedEventDetails' => [ 'base' => '

Contains details about a task that failed to start during an execution.

', 'refs' => [ 'HistoryEvent$taskStartFailedEventDetails' => '

Contains details about a task that failed to start.

', ], ], 'TaskStartedEventDetails' => [ 'base' => '

Contains details about the start of a task during an execution.

', 'refs' => [ 'HistoryEvent$taskStartedEventDetails' => '

Contains details about a task that was started.

', ], ], 'TaskSubmitFailedEventDetails' => [ 'base' => '

Contains details about a task that failed to submit during an execution.

', 'refs' => [ 'HistoryEvent$taskSubmitFailedEventDetails' => '

Contains details about a task that where the submit failed.

', ], ], 'TaskSubmittedEventDetails' => [ 'base' => '

Contains details about a task submitted to a resource .

', 'refs' => [ 'HistoryEvent$taskSubmittedEventDetails' => '

Contains details about a submitted task.

', ], ], 'TaskSucceededEventDetails' => [ 'base' => '

Contains details about the successful completion of a task state.

', 'refs' => [ 'HistoryEvent$taskSucceededEventDetails' => '

Contains details about a task that succeeded.

', ], ], 'TaskTimedOut' => [ 'base' => '

The task token has either expired or the task associated with the token has already been closed.

', 'refs' => [], ], 'TaskTimedOutEventDetails' => [ 'base' => '

Contains details about a resource timeout that occurred during an execution.

', 'refs' => [ 'HistoryEvent$taskTimedOutEventDetails' => '

Contains details about a task that timed out.

', ], ], 'TaskToken' => [ 'base' => NULL, 'refs' => [ 'GetActivityTaskOutput$taskToken' => '

A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

', 'SendTaskFailureInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', 'SendTaskHeartbeatInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', 'SendTaskSuccessInput$taskToken' => '

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

', ], ], 'TestExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'TestStateOutput$status' => '

The execution status of the state.

', ], ], 'TestStateInput' => [ 'base' => NULL, 'refs' => [], ], 'TestStateOutput' => [ 'base' => NULL, 'refs' => [], ], 'TimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ActivityScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the activity task.

', 'ActivityScheduledEventDetails$heartbeatInSeconds' => '

The maximum allowed duration between two heartbeats for the activity task.

', 'LambdaFunctionScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the Lambda function.

', 'TaskScheduledEventDetails$timeoutInSeconds' => '

The maximum allowed duration of the task.

', 'TaskScheduledEventDetails$heartbeatInSeconds' => '

The maximum allowed duration between two heartbeats for the task.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActivityListItem$creationDate' => '

The date the activity is created.

', 'CreateActivityOutput$creationDate' => '

The date the activity is created.

', 'CreateStateMachineAliasOutput$creationDate' => '

The date the state machine alias was created.

', 'CreateStateMachineOutput$creationDate' => '

The date the state machine is created.

', 'DescribeActivityOutput$creationDate' => '

The date the activity is created.

', 'DescribeExecutionOutput$startDate' => '

The date the execution is started.

', 'DescribeExecutionOutput$stopDate' => '

If the execution ended, the date the execution stopped.

', 'DescribeExecutionOutput$redriveDate' => '

The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

', 'DescribeMapRunOutput$startDate' => '

The date when the Map Run was started.

', 'DescribeMapRunOutput$stopDate' => '

The date when the Map Run was stopped.

', 'DescribeMapRunOutput$redriveDate' => '

The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

', 'DescribeStateMachineAliasOutput$creationDate' => '

The date the state machine alias was created.

', 'DescribeStateMachineAliasOutput$updateDate' => '

The date the state machine alias was last updated.

For a newly created state machine, this is the same as the creation date.

', 'DescribeStateMachineForExecutionOutput$updateDate' => '

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

', 'DescribeStateMachineOutput$creationDate' => '

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

', 'ExecutionListItem$startDate' => '

The date the execution started.

', 'ExecutionListItem$stopDate' => '

If the execution already ended, the date the execution stopped.

', 'ExecutionListItem$redriveDate' => '

The date the execution was last redriven.

', 'HistoryEvent$timestamp' => '

The date and time the event occurred.

', 'MapRunListItem$startDate' => '

The date on which the Map Run started.

', 'MapRunListItem$stopDate' => '

The date on which the Map Run stopped.

', 'PublishStateMachineVersionOutput$creationDate' => '

The date the version was created.

', 'RedriveExecutionOutput$redriveDate' => '

The date the execution was last redriven.

', 'StartExecutionOutput$startDate' => '

The date the execution is started.

', 'StartSyncExecutionOutput$startDate' => '

The date the execution is started.

', 'StartSyncExecutionOutput$stopDate' => '

If the execution has already ended, the date the execution stopped.

', 'StateMachineAliasListItem$creationDate' => '

The creation date of a state machine alias.

', 'StateMachineListItem$creationDate' => '

The date the state machine is created.

', 'StateMachineVersionListItem$creationDate' => '

The creation date of a state machine version.

', 'StopExecutionOutput$stopDate' => '

The date the execution is stopped.

', 'UpdateStateMachineAliasOutput$updateDate' => '

The date and time the state machine alias was updated.

', 'UpdateStateMachineOutput$updateDate' => '

The date and time the state machine was updated.

', ], ], 'ToleratedFailureCount' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailureCount' => '

The maximum number of failed child workflow executions before the Map Run fails.

', 'UpdateMapRunInput$toleratedFailureCount' => '

The maximum number of failed items before the Map Run fails.

', ], ], 'ToleratedFailurePercentage' => [ 'base' => NULL, 'refs' => [ 'DescribeMapRunOutput$toleratedFailurePercentage' => '

The maximum percentage of failed child workflow executions before the Map Run fails.

', 'UpdateMapRunInput$toleratedFailurePercentage' => '

The maximum percentage of failed items before the Map Run fails.

', ], ], 'TooManyTags' => [ 'base' => '

You\'ve exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

', 'refs' => [], ], 'TraceHeader' => [ 'base' => NULL, 'refs' => [ 'DescribeExecutionOutput$traceHeader' => '

The X-Ray trace header that was passed to the execution.

', 'StartExecutionInput$traceHeader' => '

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

', 'StartSyncExecutionInput$traceHeader' => '

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

', 'StartSyncExecutionOutput$traceHeader' => '

The X-Ray trace header that was passed to the execution.

', ], ], 'TracingConfiguration' => [ 'base' => '

Selects whether or not the state machine\'s X-Ray tracing is enabled. Default is false

', 'refs' => [ 'CreateStateMachineInput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'DescribeStateMachineForExecutionOutput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'DescribeStateMachineOutput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', 'UpdateStateMachineInput$tracingConfiguration' => '

Selects whether X-Ray tracing is enabled.

', ], ], 'URL' => [ 'base' => NULL, 'refs' => [ 'InspectionDataRequest$url' => '

The API endpoint used for the HTTP request.

', ], ], 'UnsignedInteger' => [ 'base' => NULL, 'refs' => [ 'ExecutionListItem$itemCount' => '

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn\'t returned.

', 'MapIterationEventDetails$index' => '

The index of the array belonging to the Map state iteration.

', 'MapStateStartedEventDetails$length' => '

The size of the array for Map state iterations.

', ], ], 'UnsignedLong' => [ 'base' => NULL, 'refs' => [ 'MapRunExecutionCounts$pending' => '

The total number of child workflow executions that were started by a Map Run, but haven\'t started executing yet.

', 'MapRunExecutionCounts$running' => '

The total number of child workflow executions that were started by a Map Run and are currently in-progress.

', 'MapRunExecutionCounts$succeeded' => '

The total number of child workflow executions that were started by a Map Run and have completed successfully.

', 'MapRunExecutionCounts$failed' => '

The total number of child workflow executions that were started by a Map Run, but have failed.

', 'MapRunExecutionCounts$timedOut' => '

The total number of child workflow executions that were started by a Map Run and have timed out.

', 'MapRunExecutionCounts$aborted' => '

The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.

', 'MapRunExecutionCounts$total' => '

The total number of child workflow executions that were started by a Map Run.

', 'MapRunExecutionCounts$resultsWritten' => '

Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

', 'MapRunItemCounts$pending' => '

The total number of items to process in child workflow executions that haven\'t started running yet.

', 'MapRunItemCounts$running' => '

The total number of items being processed in child workflow executions that are currently in-progress.

', 'MapRunItemCounts$succeeded' => '

The total number of items processed in child workflow executions that have completed successfully.

', 'MapRunItemCounts$failed' => '

The total number of items processed in child workflow executions that have failed.

', 'MapRunItemCounts$timedOut' => '

The total number of items processed in child workflow executions that have timed out.

', 'MapRunItemCounts$aborted' => '

The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

', 'MapRunItemCounts$total' => '

The total number of items processed in all the child workflow executions started by a Map Run.

', 'MapRunItemCounts$resultsWritten' => '

Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMapRunInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMapRunOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineAliasInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineAliasOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStateMachineOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionCode' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$code' => '

Identifying code for the diagnostic.

', ], ], 'ValidateStateMachineDefinitionDiagnostic' => [ 'base' => '

Describes an error found during validation. Validation errors found in the definition return in the response as diagnostic elements, rather than raise an exception.

', 'refs' => [ 'ValidateStateMachineDefinitionDiagnosticList$member' => NULL, ], ], 'ValidateStateMachineDefinitionDiagnosticList' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionOutput$diagnostics' => '

If the result is OK, this field will be empty. When there are errors, this field will contain an array of Diagnostic objects to help you troubleshoot.

', ], ], 'ValidateStateMachineDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionLocation' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$location' => '

Location of the issue in the state machine, if available.

For errors specific to a field, the location could be in the format: /States/<StateName>/<FieldName>, for example: /States/FailState/ErrorPath.

', ], ], 'ValidateStateMachineDefinitionMaxResult' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionInput$maxResults' => '

The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.

If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.

', ], ], 'ValidateStateMachineDefinitionMessage' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$message' => '

Message describing the diagnostic condition.

', ], ], 'ValidateStateMachineDefinitionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidateStateMachineDefinitionResultCode' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionOutput$result' => '

The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.

', ], ], 'ValidateStateMachineDefinitionSeverity' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionDiagnostic$severity' => '

A value of ERROR means that you cannot create or update a state machine with this definition.

', 'ValidateStateMachineDefinitionInput$severity' => '

Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.

', ], ], 'ValidateStateMachineDefinitionTruncated' => [ 'base' => NULL, 'refs' => [ 'ValidateStateMachineDefinitionOutput$truncated' => '

The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.

', ], ], 'ValidationException' => [ 'base' => '

The input does not satisfy the constraints specified by an Amazon Web Services service.

', 'refs' => [], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => '

The input does not satisfy the constraints specified by an Amazon Web Services service.

', ], ], 'VersionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateStateMachineInput$versionDescription' => '

Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.

', 'DescribeStateMachineOutput$description' => '

The description of the state machine version.

', 'PublishStateMachineVersionInput$description' => '

An optional description of the state machine version.

', 'UpdateStateMachineInput$versionDescription' => '

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you\'ve set publish to true.

', ], ], 'VersionWeight' => [ 'base' => NULL, 'refs' => [ 'RoutingConfigurationListItem$weight' => '

The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.

', ], ], 'includedDetails' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEventsExecutionDataDetails$included' => '

Indicates whether input or output was included in the response. Always true for API calls.

', ], ], 'truncated' => [ 'base' => NULL, 'refs' => [ 'HistoryEventExecutionDataDetails$truncated' => '

Indicates whether input or output was truncated in the response. Always false for API calls.

', ], ], ],]; diff --git a/src/data/wafv2/2019-07-29/api-2.json b/src/data/wafv2/2019-07-29/api-2.json index ab7d1841ab..0b9a7a940d 100644 --- a/src/data/wafv2/2019-07-29/api-2.json +++ b/src/data/wafv2/2019-07-29/api-2.json @@ -3281,7 +3281,7 @@ "RateLimit":{ "type":"long", "max":2000000000, - "min":100 + "min":10 }, "RateLimitCookie":{ "type":"structure", diff --git a/src/data/wafv2/2019-07-29/api-2.json.php b/src/data/wafv2/2019-07-29/api-2.json.php index e1105a474b..443b54a68c 100644 --- a/src/data/wafv2/2019-07-29/api-2.json.php +++ b/src/data/wafv2/2019-07-29/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2019-07-29', 'endpointPrefix' => 'wafv2', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'WAFV2', 'serviceFullName' => 'AWS WAFV2', 'serviceId' => 'WAFV2', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSWAF_20190729', 'uid' => 'wafv2-2019-07-29', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AssociateWebACL' => [ 'name' => 'AssociateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateWebACLRequest', ], 'output' => [ 'shape' => 'AssociateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CheckCapacity' => [ 'name' => 'CheckCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CheckCapacityRequest', ], 'output' => [ 'shape' => 'CheckCapacityResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateAPIKey' => [ 'name' => 'CreateAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAPIKeyRequest', ], 'output' => [ 'shape' => 'CreateAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFLimitsExceededException', ], ], ], 'CreateIPSet' => [ 'name' => 'CreateIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIPSetRequest', ], 'output' => [ 'shape' => 'CreateIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateRegexPatternSet' => [ 'name' => 'CreateRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegexPatternSetRequest', ], 'output' => [ 'shape' => 'CreateRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateRuleGroup' => [ 'name' => 'CreateRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRuleGroupRequest', ], 'output' => [ 'shape' => 'CreateRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateWebACL' => [ 'name' => 'CreateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWebACLRequest', ], 'output' => [ 'shape' => 'CreateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFConfigurationWarningException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], ], ], 'DeleteAPIKey' => [ 'name' => 'DeleteAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAPIKeyRequest', ], 'output' => [ 'shape' => 'DeleteAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteFirewallManagerRuleGroups' => [ 'name' => 'DeleteFirewallManagerRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallManagerRuleGroupsRequest', ], 'output' => [ 'shape' => 'DeleteFirewallManagerRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteIPSet' => [ 'name' => 'DeleteIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIPSetRequest', ], 'output' => [ 'shape' => 'DeleteIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteLoggingConfiguration' => [ 'name' => 'DeleteLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeletePermissionPolicy' => [ 'name' => 'DeletePermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePermissionPolicyRequest', ], 'output' => [ 'shape' => 'DeletePermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DeleteRegexPatternSet' => [ 'name' => 'DeleteRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegexPatternSetRequest', ], 'output' => [ 'shape' => 'DeleteRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteRuleGroup' => [ 'name' => 'DeleteRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRuleGroupRequest', ], 'output' => [ 'shape' => 'DeleteRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteWebACL' => [ 'name' => 'DeleteWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWebACLRequest', ], 'output' => [ 'shape' => 'DeleteWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DescribeAllManagedProducts' => [ 'name' => 'DescribeAllManagedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAllManagedProductsRequest', ], 'output' => [ 'shape' => 'DescribeAllManagedProductsResponse', ], 'errors' => [ [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DescribeManagedProductsByVendor' => [ 'name' => 'DescribeManagedProductsByVendor', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeManagedProductsByVendorRequest', ], 'output' => [ 'shape' => 'DescribeManagedProductsByVendorResponse', ], 'errors' => [ [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DescribeManagedRuleGroup' => [ 'name' => 'DescribeManagedRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeManagedRuleGroupRequest', ], 'output' => [ 'shape' => 'DescribeManagedRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], ], ], 'DisassociateWebACL' => [ 'name' => 'DisassociateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateWebACLRequest', ], 'output' => [ 'shape' => 'DisassociateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GenerateMobileSdkReleaseUrl' => [ 'name' => 'GenerateMobileSdkReleaseUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GenerateMobileSdkReleaseUrlRequest', ], 'output' => [ 'shape' => 'GenerateMobileSdkReleaseUrlResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetDecryptedAPIKey' => [ 'name' => 'GetDecryptedAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDecryptedAPIKeyRequest', ], 'output' => [ 'shape' => 'GetDecryptedAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInvalidResourceException', ], ], ], 'GetIPSet' => [ 'name' => 'GetIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetIPSetRequest', ], 'output' => [ 'shape' => 'GetIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetLoggingConfiguration' => [ 'name' => 'GetLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetManagedRuleSet' => [ 'name' => 'GetManagedRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetManagedRuleSetRequest', ], 'output' => [ 'shape' => 'GetManagedRuleSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetMobileSdkRelease' => [ 'name' => 'GetMobileSdkRelease', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileSdkReleaseRequest', ], 'output' => [ 'shape' => 'GetMobileSdkReleaseResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetPermissionPolicy' => [ 'name' => 'GetPermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPermissionPolicyRequest', ], 'output' => [ 'shape' => 'GetPermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'GetRateBasedStatementManagedKeys' => [ 'name' => 'GetRateBasedStatementManagedKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRateBasedStatementManagedKeysRequest', ], 'output' => [ 'shape' => 'GetRateBasedStatementManagedKeysResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFUnsupportedAggregateKeyTypeException', ], ], ], 'GetRegexPatternSet' => [ 'name' => 'GetRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegexPatternSetRequest', ], 'output' => [ 'shape' => 'GetRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetRuleGroup' => [ 'name' => 'GetRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRuleGroupRequest', ], 'output' => [ 'shape' => 'GetRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetSampledRequests' => [ 'name' => 'GetSampledRequests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSampledRequestsRequest', ], 'output' => [ 'shape' => 'GetSampledRequestsResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'GetWebACL' => [ 'name' => 'GetWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetWebACLRequest', ], 'output' => [ 'shape' => 'GetWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetWebACLForResource' => [ 'name' => 'GetWebACLForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetWebACLForResourceRequest', ], 'output' => [ 'shape' => 'GetWebACLForResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListAPIKeys' => [ 'name' => 'ListAPIKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAPIKeysRequest', ], 'output' => [ 'shape' => 'ListAPIKeysResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInvalidResourceException', ], ], ], 'ListAvailableManagedRuleGroupVersions' => [ 'name' => 'ListAvailableManagedRuleGroupVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailableManagedRuleGroupVersionsRequest', ], 'output' => [ 'shape' => 'ListAvailableManagedRuleGroupVersionsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListAvailableManagedRuleGroups' => [ 'name' => 'ListAvailableManagedRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailableManagedRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListAvailableManagedRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListIPSets' => [ 'name' => 'ListIPSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListIPSetsRequest', ], 'output' => [ 'shape' => 'ListIPSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListLoggingConfigurations' => [ 'name' => 'ListLoggingConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLoggingConfigurationsRequest', ], 'output' => [ 'shape' => 'ListLoggingConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListManagedRuleSets' => [ 'name' => 'ListManagedRuleSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListManagedRuleSetsRequest', ], 'output' => [ 'shape' => 'ListManagedRuleSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListMobileSdkReleases' => [ 'name' => 'ListMobileSdkReleases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileSdkReleasesRequest', ], 'output' => [ 'shape' => 'ListMobileSdkReleasesResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListRegexPatternSets' => [ 'name' => 'ListRegexPatternSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRegexPatternSetsRequest', ], 'output' => [ 'shape' => 'ListRegexPatternSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListResourcesForWebACL' => [ 'name' => 'ListResourcesForWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesForWebACLRequest', ], 'output' => [ 'shape' => 'ListResourcesForWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListRuleGroups' => [ 'name' => 'ListRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListWebACLs' => [ 'name' => 'ListWebACLs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWebACLsRequest', ], 'output' => [ 'shape' => 'ListWebACLsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'PutLoggingConfiguration' => [ 'name' => 'PutLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFServiceLinkedRoleErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFLogDestinationPermissionIssueException', ], ], ], 'PutManagedRuleSetVersions' => [ 'name' => 'PutManagedRuleSetVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutManagedRuleSetVersionsRequest', ], 'output' => [ 'shape' => 'PutManagedRuleSetVersionsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'PutPermissionPolicy' => [ 'name' => 'PutPermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPermissionPolicyRequest', ], 'output' => [ 'shape' => 'PutPermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidPermissionPolicyException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateIPSet' => [ 'name' => 'UpdateIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateIPSetRequest', ], 'output' => [ 'shape' => 'UpdateIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateManagedRuleSetVersionExpiryDate' => [ 'name' => 'UpdateManagedRuleSetVersionExpiryDate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateManagedRuleSetVersionExpiryDateRequest', ], 'output' => [ 'shape' => 'UpdateManagedRuleSetVersionExpiryDateResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateRegexPatternSet' => [ 'name' => 'UpdateRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRegexPatternSetRequest', ], 'output' => [ 'shape' => 'UpdateRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateRuleGroup' => [ 'name' => 'UpdateRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRuleGroupRequest', ], 'output' => [ 'shape' => 'UpdateRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFConfigurationWarningException', ], ], ], 'UpdateWebACL' => [ 'name' => 'UpdateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWebACLRequest', ], 'output' => [ 'shape' => 'UpdateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], [ 'shape' => 'WAFConfigurationWarningException', ], ], ], ], 'shapes' => [ 'APIKey' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*\\S.*', ], 'APIKeySummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'APIKeySummary', ], ], 'APIKeySummary' => [ 'type' => 'structure', 'members' => [ 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'APIKey' => [ 'shape' => 'APIKey', ], 'CreationTimestamp' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'APIKeyVersion', ], ], ], 'APIKeyTokenDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'TokenDomain', ], 'min' => 1, ], 'APIKeyVersion' => [ 'type' => 'integer', 'min' => 0, ], 'AWSManagedRulesACFPRuleSet' => [ 'type' => 'structure', 'required' => [ 'CreationPath', 'RegistrationPagePath', 'RequestInspection', ], 'members' => [ 'CreationPath' => [ 'shape' => 'CreationPathString', ], 'RegistrationPagePath' => [ 'shape' => 'RegistrationPagePathString', ], 'RequestInspection' => [ 'shape' => 'RequestInspectionACFP', ], 'ResponseInspection' => [ 'shape' => 'ResponseInspection', ], 'EnableRegexInPath' => [ 'shape' => 'Boolean', ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'type' => 'structure', 'required' => [ 'LoginPath', ], 'members' => [ 'LoginPath' => [ 'shape' => 'String', ], 'RequestInspection' => [ 'shape' => 'RequestInspection', ], 'ResponseInspection' => [ 'shape' => 'ResponseInspection', ], 'EnableRegexInPath' => [ 'shape' => 'Boolean', ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'type' => 'structure', 'required' => [ 'InspectionLevel', ], 'members' => [ 'InspectionLevel' => [ 'shape' => 'InspectionLevel', ], 'EnableMachineLearning' => [ 'shape' => 'EnableMachineLearning', ], ], ], 'Action' => [ 'type' => 'string', ], 'ActionCondition' => [ 'type' => 'structure', 'required' => [ 'Action', ], 'members' => [ 'Action' => [ 'shape' => 'ActionValue', ], ], ], 'ActionValue' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', 'COUNT', 'CAPTCHA', 'CHALLENGE', 'EXCLUDED_AS_COUNT', ], ], 'AddressField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'AddressFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddressField', ], ], 'All' => [ 'type' => 'structure', 'members' => [], ], 'AllQueryArguments' => [ 'type' => 'structure', 'members' => [], ], 'AllowAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'AndStatement' => [ 'type' => 'structure', 'required' => [ 'Statements', ], 'members' => [ 'Statements' => [ 'shape' => 'Statements', ], ], ], 'AssociateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', 'ResourceArn', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'AssociateWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociatedResourceType' => [ 'type' => 'string', 'enum' => [ 'CLOUDFRONT', 'API_GATEWAY', 'COGNITO_USER_POOL', 'APP_RUNNER_SERVICE', 'VERIFIED_ACCESS_INSTANCE', ], ], 'AssociationConfig' => [ 'type' => 'structure', 'members' => [ 'RequestBody' => [ 'shape' => 'RequestBody', ], ], ], 'BlockAction' => [ 'type' => 'structure', 'members' => [ 'CustomResponse' => [ 'shape' => 'CustomResponse', ], ], ], 'Body' => [ 'type' => 'structure', 'members' => [ 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'BodyParsingFallbackBehavior' => [ 'type' => 'string', 'enum' => [ 'MATCH', 'NO_MATCH', 'EVALUATE_AS_STRING', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ByteMatchStatement' => [ 'type' => 'structure', 'required' => [ 'SearchString', 'FieldToMatch', 'TextTransformations', 'PositionalConstraint', ], 'members' => [ 'SearchString' => [ 'shape' => 'SearchString', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], 'PositionalConstraint' => [ 'shape' => 'PositionalConstraint', ], ], ], 'CapacityUnit' => [ 'type' => 'long', 'min' => 1, ], 'CaptchaAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'CaptchaConfig' => [ 'type' => 'structure', 'members' => [ 'ImmunityTimeProperty' => [ 'shape' => 'ImmunityTimeProperty', ], ], ], 'CaptchaResponse' => [ 'type' => 'structure', 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseCode', ], 'SolveTimestamp' => [ 'shape' => 'SolveTimestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'ChallengeAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'ChallengeConfig' => [ 'type' => 'structure', 'members' => [ 'ImmunityTimeProperty' => [ 'shape' => 'ImmunityTimeProperty', ], ], ], 'ChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseCode', ], 'SolveTimestamp' => [ 'shape' => 'SolveTimestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'CheckCapacityRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'Rules', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'Rules' => [ 'shape' => 'Rules', ], ], ], 'CheckCapacityResponse' => [ 'type' => 'structure', 'members' => [ 'Capacity' => [ 'shape' => 'ConsumedCapacity', ], ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'EQ', 'NE', 'LE', 'LT', 'GE', 'GT', ], ], 'Condition' => [ 'type' => 'structure', 'members' => [ 'ActionCondition' => [ 'shape' => 'ActionCondition', ], 'LabelNameCondition' => [ 'shape' => 'LabelNameCondition', ], ], ], 'Conditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Condition', ], 'min' => 1, ], 'ConsumedCapacity' => [ 'type' => 'long', 'min' => 0, ], 'CookieMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedCookies' => [ 'shape' => 'CookieNames', ], 'ExcludedCookies' => [ 'shape' => 'CookieNames', ], ], ], 'CookieNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'SingleCookieName', ], 'max' => 199, 'min' => 1, ], 'Cookies' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', 'OversizeHandling', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'CookieMatchPattern', ], 'MatchScope' => [ 'shape' => 'MapMatchScope', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'CountAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'Country' => [ 'type' => 'string', ], 'CountryCode' => [ 'type' => 'string', 'enum' => [ 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BQ', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CG', 'CD', 'CK', 'CR', 'CI', 'HR', 'CU', 'CW', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'SS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW', 'XK', ], ], 'CountryCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CountryCode', ], 'min' => 1, ], 'CreateAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'TokenDomains', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'TokenDomains' => [ 'shape' => 'APIKeyTokenDomains', ], ], ], 'CreateAPIKeyResponse' => [ 'type' => 'structure', 'members' => [ 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'CreateIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'IPAddressVersion', 'Addresses', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'IPSetSummary', ], ], ], 'CreateRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'RegularExpressionList', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'RegexPatternSetSummary', ], ], ], 'CreateRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Capacity', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], ], ], 'CreateRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'RuleGroupSummary', ], ], ], 'CreateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'DefaultAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'CreateWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'WebACLSummary', ], ], ], 'CreationPathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'CustomHTTPHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'CustomHTTPHeaderName', ], 'Value' => [ 'shape' => 'CustomHTTPHeaderValue', ], ], ], 'CustomHTTPHeaderName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9._$-]+$', ], 'CustomHTTPHeaderValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'CustomHTTPHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomHTTPHeader', ], 'min' => 1, ], 'CustomRequestHandling' => [ 'type' => 'structure', 'required' => [ 'InsertHeaders', ], 'members' => [ 'InsertHeaders' => [ 'shape' => 'CustomHTTPHeaders', ], ], ], 'CustomResponse' => [ 'type' => 'structure', 'required' => [ 'ResponseCode', ], 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseStatusCode', ], 'CustomResponseBodyKey' => [ 'shape' => 'EntityName', ], 'ResponseHeaders' => [ 'shape' => 'CustomHTTPHeaders', ], ], ], 'CustomResponseBodies' => [ 'type' => 'map', 'key' => [ 'shape' => 'EntityName', ], 'value' => [ 'shape' => 'CustomResponseBody', ], 'min' => 1, ], 'CustomResponseBody' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'Content', ], 'members' => [ 'ContentType' => [ 'shape' => 'ResponseContentType', ], 'Content' => [ 'shape' => 'ResponseContent', ], ], ], 'DefaultAction' => [ 'type' => 'structure', 'members' => [ 'Block' => [ 'shape' => 'BlockAction', ], 'Allow' => [ 'shape' => 'AllowAction', ], ], ], 'DeleteAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'APIKey', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'DeleteAPIKeyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteFirewallManagerRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', 'WebACLLockToken', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'WebACLLockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteFirewallManagerRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextWebACLLockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteIPSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'DeleteLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeletePermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'DeletePermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteRuleGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAllManagedProductsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], ], ], 'DescribeAllManagedProductsResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedProducts' => [ 'shape' => 'ManagedProductDescriptors', ], ], ], 'DescribeManagedProductsByVendorRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Scope' => [ 'shape' => 'Scope', ], ], ], 'DescribeManagedProductsByVendorResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedProducts' => [ 'shape' => 'ManagedProductDescriptors', ], ], ], 'DescribeManagedRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'VersionName' => [ 'shape' => 'VersionKeyString', ], ], ], 'DescribeManagedRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VersionName' => [ 'shape' => 'VersionKeyString', ], 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'Rules' => [ 'shape' => 'RuleSummaries', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'AvailableLabels' => [ 'shape' => 'LabelSummaries', ], 'ConsumedLabels' => [ 'shape' => 'LabelSummaries', ], ], ], 'DisassociateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'DisassociateWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'DownloadUrl' => [ 'type' => 'string', ], 'EmailField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'EnableMachineLearning' => [ 'type' => 'boolean', ], 'EntityDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$', ], 'EntityId' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$', ], 'EntityName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\w\\-]+$', ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorReason' => [ 'type' => 'string', ], 'EvaluationWindowSec' => [ 'type' => 'long', ], 'ExcludedRule' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], ], ], 'ExcludedRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExcludedRule', ], 'max' => 100, ], 'FailureCode' => [ 'type' => 'integer', 'max' => 999, 'min' => 0, ], 'FailureReason' => [ 'type' => 'string', 'enum' => [ 'TOKEN_MISSING', 'TOKEN_EXPIRED', 'TOKEN_INVALID', 'TOKEN_DOMAIN_MISMATCH', ], ], 'FailureValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '.*\\S.*', ], 'FallbackBehavior' => [ 'type' => 'string', 'enum' => [ 'MATCH', 'NO_MATCH', ], ], 'FieldIdentifier' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*\\S.*', ], 'FieldToMatch' => [ 'type' => 'structure', 'members' => [ 'SingleHeader' => [ 'shape' => 'SingleHeader', ], 'SingleQueryArgument' => [ 'shape' => 'SingleQueryArgument', ], 'AllQueryArguments' => [ 'shape' => 'AllQueryArguments', ], 'UriPath' => [ 'shape' => 'UriPath', ], 'QueryString' => [ 'shape' => 'QueryString', ], 'Body' => [ 'shape' => 'Body', ], 'Method' => [ 'shape' => 'Method', ], 'JsonBody' => [ 'shape' => 'JsonBody', ], 'Headers' => [ 'shape' => 'Headers', ], 'Cookies' => [ 'shape' => 'Cookies', ], 'HeaderOrder' => [ 'shape' => 'HeaderOrder', ], 'JA3Fingerprint' => [ 'shape' => 'JA3Fingerprint', ], ], ], 'FieldToMatchData' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*\\S.*', ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Behavior', 'Requirement', 'Conditions', ], 'members' => [ 'Behavior' => [ 'shape' => 'FilterBehavior', ], 'Requirement' => [ 'shape' => 'FilterRequirement', ], 'Conditions' => [ 'shape' => 'Conditions', ], ], ], 'FilterBehavior' => [ 'type' => 'string', 'enum' => [ 'KEEP', 'DROP', ], ], 'FilterRequirement' => [ 'type' => 'string', 'enum' => [ 'MEETS_ALL', 'MEETS_ANY', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'min' => 1, ], 'FirewallManagerRuleGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Priority', 'FirewallManagerStatement', 'OverrideAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Priority' => [ 'shape' => 'RulePriority', ], 'FirewallManagerStatement' => [ 'shape' => 'FirewallManagerStatement', ], 'OverrideAction' => [ 'shape' => 'OverrideAction', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], ], ], 'FirewallManagerRuleGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallManagerRuleGroup', ], ], 'FirewallManagerStatement' => [ 'type' => 'structure', 'members' => [ 'ManagedRuleGroupStatement' => [ 'shape' => 'ManagedRuleGroupStatement', ], 'RuleGroupReferenceStatement' => [ 'shape' => 'RuleGroupReferenceStatement', ], ], ], 'ForwardedIPConfig' => [ 'type' => 'structure', 'required' => [ 'HeaderName', 'FallbackBehavior', ], 'members' => [ 'HeaderName' => [ 'shape' => 'ForwardedIPHeaderName', ], 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], ], ], 'ForwardedIPHeaderName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ForwardedIPPosition' => [ 'type' => 'string', 'enum' => [ 'FIRST', 'LAST', 'ANY', ], ], 'GenerateMobileSdkReleaseUrlRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', 'ReleaseVersion', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'GenerateMobileSdkReleaseUrlResponse' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'DownloadUrl', ], ], ], 'GeoMatchStatement' => [ 'type' => 'structure', 'members' => [ 'CountryCodes' => [ 'shape' => 'CountryCodes', ], 'ForwardedIPConfig' => [ 'shape' => 'ForwardedIPConfig', ], ], ], 'GetDecryptedAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'APIKey', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'GetDecryptedAPIKeyResponse' => [ 'type' => 'structure', 'members' => [ 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'CreationTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'GetIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'IPSet' => [ 'shape' => 'IPSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'GetLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'GetManagedRuleSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetManagedRuleSetResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedRuleSet' => [ 'shape' => 'ManagedRuleSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetMobileSdkReleaseRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', 'ReleaseVersion', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'GetMobileSdkReleaseResponse' => [ 'type' => 'structure', 'members' => [ 'MobileSdkRelease' => [ 'shape' => 'MobileSdkRelease', ], ], ], 'GetPermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetPermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'PolicyString', ], ], ], 'GetRateBasedStatementManagedKeysRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'WebACLName', 'WebACLId', 'RuleName', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'WebACLName' => [ 'shape' => 'EntityName', ], 'WebACLId' => [ 'shape' => 'EntityId', ], 'RuleGroupRuleName' => [ 'shape' => 'EntityName', ], 'RuleName' => [ 'shape' => 'EntityName', ], ], ], 'GetRateBasedStatementManagedKeysResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedKeysIPV4' => [ 'shape' => 'RateBasedStatementManagedKeysIPSet', ], 'ManagedKeysIPV6' => [ 'shape' => 'RateBasedStatementManagedKeysIPSet', ], ], ], 'GetRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'RegexPatternSet' => [ 'shape' => 'RegexPatternSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetRuleGroupRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'GetRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'RuleGroup' => [ 'shape' => 'RuleGroup', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetSampledRequestsRequest' => [ 'type' => 'structure', 'required' => [ 'WebAclArn', 'RuleMetricName', 'Scope', 'TimeWindow', 'MaxItems', ], 'members' => [ 'WebAclArn' => [ 'shape' => 'ResourceArn', ], 'RuleMetricName' => [ 'shape' => 'MetricName', ], 'Scope' => [ 'shape' => 'Scope', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], 'MaxItems' => [ 'shape' => 'ListMaxItems', ], ], ], 'GetSampledRequestsResponse' => [ 'type' => 'structure', 'members' => [ 'SampledRequests' => [ 'shape' => 'SampledHTTPRequests', ], 'PopulationSize' => [ 'shape' => 'PopulationSize', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], ], ], 'GetWebACLForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetWebACLForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'WebACL' => [ 'shape' => 'WebACL', ], ], ], 'GetWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'WebACL' => [ 'shape' => 'WebACL', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ApplicationIntegrationURL' => [ 'shape' => 'OutputUrl', ], ], ], 'HTTPHeader' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'HeaderName', ], 'Value' => [ 'shape' => 'HeaderValue', ], ], ], 'HTTPHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'HTTPHeader', ], ], 'HTTPMethod' => [ 'type' => 'string', ], 'HTTPRequest' => [ 'type' => 'structure', 'members' => [ 'ClientIP' => [ 'shape' => 'IPString', ], 'Country' => [ 'shape' => 'Country', ], 'URI' => [ 'shape' => 'URIString', ], 'Method' => [ 'shape' => 'HTTPMethod', ], 'HTTPVersion' => [ 'shape' => 'HTTPVersion', ], 'Headers' => [ 'shape' => 'HTTPHeaders', ], ], ], 'HTTPVersion' => [ 'type' => 'string', ], 'HeaderMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedHeaders' => [ 'shape' => 'HeaderNames', ], 'ExcludedHeaders' => [ 'shape' => 'HeaderNames', ], ], ], 'HeaderName' => [ 'type' => 'string', ], 'HeaderNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldToMatchData', ], 'max' => 199, 'min' => 1, ], 'HeaderOrder' => [ 'type' => 'structure', 'required' => [ 'OversizeHandling', ], 'members' => [ 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'HeaderValue' => [ 'type' => 'string', ], 'Headers' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', 'OversizeHandling', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'HeaderMatchPattern', ], 'MatchScope' => [ 'shape' => 'MapMatchScope', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'IPAddress' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '.*\\S.*', ], 'IPAddressVersion' => [ 'type' => 'string', 'enum' => [ 'IPV4', 'IPV6', ], ], 'IPAddresses' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPAddress', ], ], 'IPSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', 'IPAddressVersion', 'Addresses', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], ], ], 'IPSetForwardedIPConfig' => [ 'type' => 'structure', 'required' => [ 'HeaderName', 'FallbackBehavior', 'Position', ], 'members' => [ 'HeaderName' => [ 'shape' => 'ForwardedIPHeaderName', ], 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], 'Position' => [ 'shape' => 'ForwardedIPPosition', ], ], ], 'IPSetReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'IPSetForwardedIPConfig' => [ 'shape' => 'IPSetForwardedIPConfig', ], ], ], 'IPSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPSetSummary', ], ], 'IPSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'IPString' => [ 'type' => 'string', ], 'ImmunityTimeProperty' => [ 'type' => 'structure', 'required' => [ 'ImmunityTime', ], 'members' => [ 'ImmunityTime' => [ 'shape' => 'TimeWindowSecond', ], ], ], 'InspectionLevel' => [ 'type' => 'string', 'enum' => [ 'COMMON', 'TARGETED', ], ], 'JA3Fingerprint' => [ 'type' => 'structure', 'required' => [ 'FallbackBehavior', ], 'members' => [ 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], ], ], 'JsonBody' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'JsonMatchPattern', ], 'MatchScope' => [ 'shape' => 'JsonMatchScope', ], 'InvalidFallbackBehavior' => [ 'shape' => 'BodyParsingFallbackBehavior', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'JsonMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedPaths' => [ 'shape' => 'JsonPointerPaths', ], ], ], 'JsonMatchScope' => [ 'type' => 'string', 'enum' => [ 'ALL', 'KEY', 'VALUE', ], ], 'JsonPointerPath' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '([/])|([/](([^~])|(~[01]))+)', ], 'JsonPointerPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonPointerPath', ], 'min' => 1, ], 'Label' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'LabelName', ], ], ], 'LabelMatchKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+$', ], 'LabelMatchScope' => [ 'type' => 'string', 'enum' => [ 'LABEL', 'NAMESPACE', ], ], 'LabelMatchStatement' => [ 'type' => 'structure', 'required' => [ 'Scope', 'Key', ], 'members' => [ 'Scope' => [ 'shape' => 'LabelMatchScope', ], 'Key' => [ 'shape' => 'LabelMatchKey', ], ], ], 'LabelName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+$', ], 'LabelNameCondition' => [ 'type' => 'structure', 'required' => [ 'LabelName', ], 'members' => [ 'LabelName' => [ 'shape' => 'LabelName', ], ], ], 'LabelNamespace' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+:$', ], 'LabelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelSummary', ], ], 'LabelSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'LabelName', ], ], ], 'Labels' => [ 'type' => 'list', 'member' => [ 'shape' => 'Label', ], ], 'ListAPIKeysRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAPIKeysResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'APIKeySummaries' => [ 'shape' => 'APIKeySummaries', ], 'ApplicationIntegrationURL' => [ 'shape' => 'OutputUrl', ], ], ], 'ListAvailableManagedRuleGroupVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAvailableManagedRuleGroupVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Versions' => [ 'shape' => 'ManagedRuleGroupVersions', ], 'CurrentDefaultVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'ListAvailableManagedRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAvailableManagedRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'ManagedRuleGroups' => [ 'shape' => 'ManagedRuleGroupSummaries', ], ], ], 'ListIPSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListIPSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'IPSets' => [ 'shape' => 'IPSetSummaries', ], ], ], 'ListLoggingConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'ListLoggingConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfigurations' => [ 'shape' => 'LoggingConfigurations', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], ], ], 'ListManagedRuleSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListManagedRuleSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'ManagedRuleSets' => [ 'shape' => 'ManagedRuleSetSummaries', ], ], ], 'ListMaxItems' => [ 'type' => 'long', 'max' => 500, 'min' => 1, ], 'ListMobileSdkReleasesRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListMobileSdkReleasesResponse' => [ 'type' => 'structure', 'members' => [ 'ReleaseSummaries' => [ 'shape' => 'ReleaseSummaries', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], ], ], 'ListRegexPatternSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListRegexPatternSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'RegexPatternSets' => [ 'shape' => 'RegexPatternSetSummaries', ], ], ], 'ListResourcesForWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], ], ], 'ListResourcesForWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArns' => [ 'shape' => 'ResourceArns', ], ], ], 'ListRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'RuleGroups' => [ 'shape' => 'RuleGroupSummaries', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], 'ResourceARN' => [ 'shape' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'TagInfoForResource' => [ 'shape' => 'TagInfoForResource', ], ], ], 'ListWebACLsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListWebACLsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'WebACLs' => [ 'shape' => 'WebACLSummaries', ], ], ], 'LockToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$', ], 'LogDestinationConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], 'max' => 100, 'min' => 1, ], 'LogScope' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SECURITY_LAKE', ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'WAF_LOGS', ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'LogDestinationConfigs', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogDestinationConfigs' => [ 'shape' => 'LogDestinationConfigs', ], 'RedactedFields' => [ 'shape' => 'RedactedFields', ], 'ManagedByFirewallManager' => [ 'shape' => 'Boolean', ], 'LoggingFilter' => [ 'shape' => 'LoggingFilter', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'LoggingConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoggingConfiguration', ], ], 'LoggingFilter' => [ 'type' => 'structure', 'required' => [ 'Filters', 'DefaultBehavior', ], 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'DefaultBehavior' => [ 'shape' => 'FilterBehavior', ], ], ], 'LoginPathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ManagedProductDescriptor' => [ 'type' => 'structure', 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'ManagedRuleSetName' => [ 'shape' => 'EntityName', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'ProductLink' => [ 'shape' => 'ProductLink', ], 'ProductTitle' => [ 'shape' => 'ProductTitle', ], 'ProductDescription' => [ 'shape' => 'ProductDescription', ], 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'IsVersioningSupported' => [ 'shape' => 'Boolean', ], 'IsAdvancedManagedRuleSet' => [ 'shape' => 'Boolean', ], ], ], 'ManagedProductDescriptors' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedProductDescriptor', ], ], 'ManagedRuleGroupConfig' => [ 'type' => 'structure', 'members' => [ 'LoginPath' => [ 'shape' => 'LoginPathString', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet LoginPath', ], 'PayloadType' => [ 'shape' => 'PayloadType', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField', ], 'AWSManagedRulesBotControlRuleSet' => [ 'shape' => 'AWSManagedRulesBotControlRuleSet', ], 'AWSManagedRulesATPRuleSet' => [ 'shape' => 'AWSManagedRulesATPRuleSet', ], 'AWSManagedRulesACFPRuleSet' => [ 'shape' => 'AWSManagedRulesACFPRuleSet', ], ], ], 'ManagedRuleGroupConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupConfig', ], ], 'ManagedRuleGroupStatement' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Version' => [ 'shape' => 'VersionKeyString', ], 'ExcludedRules' => [ 'shape' => 'ExcludedRules', ], 'ScopeDownStatement' => [ 'shape' => 'Statement', ], 'ManagedRuleGroupConfigs' => [ 'shape' => 'ManagedRuleGroupConfigs', ], 'RuleActionOverrides' => [ 'shape' => 'RuleActionOverrides', ], ], ], 'ManagedRuleGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupSummary', ], ], 'ManagedRuleGroupSummary' => [ 'type' => 'structure', 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'VersioningSupported' => [ 'shape' => 'Boolean', ], 'Description' => [ 'shape' => 'EntityDescription', ], ], ], 'ManagedRuleGroupVersion' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'VersionKeyString', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ManagedRuleGroupVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupVersion', ], ], 'ManagedRuleSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'PublishedVersions' => [ 'shape' => 'PublishedVersions', ], 'RecommendedVersion' => [ 'shape' => 'VersionKeyString', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], ], ], 'ManagedRuleSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleSetSummary', ], ], 'ManagedRuleSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], ], ], 'ManagedRuleSetVersion' => [ 'type' => 'structure', 'members' => [ 'AssociatedRuleGroupArn' => [ 'shape' => 'ResourceArn', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'ForecastedLifetime' => [ 'shape' => 'TimeWindowDay', ], 'PublishTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MapMatchScope' => [ 'type' => 'string', 'enum' => [ 'ALL', 'KEY', 'VALUE', ], ], 'Method' => [ 'type' => 'structure', 'members' => [], ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^[\\w#:\\.\\-/]+$', ], 'MobileSdkRelease' => [ 'type' => 'structure', 'members' => [ 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'NextMarker' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NoneAction' => [ 'type' => 'structure', 'members' => [], ], 'NotStatement' => [ 'type' => 'structure', 'required' => [ 'Statement', ], 'members' => [ 'Statement' => [ 'shape' => 'Statement', ], ], ], 'OrStatement' => [ 'type' => 'structure', 'required' => [ 'Statements', ], 'members' => [ 'Statements' => [ 'shape' => 'Statements', ], ], ], 'OutputUrl' => [ 'type' => 'string', ], 'OverrideAction' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => 'CountAction', ], 'None' => [ 'shape' => 'NoneAction', ], ], ], 'OversizeHandling' => [ 'type' => 'string', 'enum' => [ 'CONTINUE', 'MATCH', 'NO_MATCH', ], ], 'PaginationLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ParameterExceptionField' => [ 'type' => 'string', 'enum' => [ 'WEB_ACL', 'RULE_GROUP', 'REGEX_PATTERN_SET', 'IP_SET', 'MANAGED_RULE_SET', 'RULE', 'EXCLUDED_RULE', 'STATEMENT', 'BYTE_MATCH_STATEMENT', 'SQLI_MATCH_STATEMENT', 'XSS_MATCH_STATEMENT', 'SIZE_CONSTRAINT_STATEMENT', 'GEO_MATCH_STATEMENT', 'RATE_BASED_STATEMENT', 'RULE_GROUP_REFERENCE_STATEMENT', 'REGEX_PATTERN_REFERENCE_STATEMENT', 'IP_SET_REFERENCE_STATEMENT', 'MANAGED_RULE_SET_STATEMENT', 'LABEL_MATCH_STATEMENT', 'AND_STATEMENT', 'OR_STATEMENT', 'NOT_STATEMENT', 'IP_ADDRESS', 'IP_ADDRESS_VERSION', 'FIELD_TO_MATCH', 'TEXT_TRANSFORMATION', 'SINGLE_QUERY_ARGUMENT', 'SINGLE_HEADER', 'DEFAULT_ACTION', 'RULE_ACTION', 'ENTITY_LIMIT', 'OVERRIDE_ACTION', 'SCOPE_VALUE', 'RESOURCE_ARN', 'RESOURCE_TYPE', 'TAGS', 'TAG_KEYS', 'METRIC_NAME', 'FIREWALL_MANAGER_STATEMENT', 'FALLBACK_BEHAVIOR', 'POSITION', 'FORWARDED_IP_CONFIG', 'IP_SET_FORWARDED_IP_CONFIG', 'HEADER_NAME', 'CUSTOM_REQUEST_HANDLING', 'RESPONSE_CONTENT_TYPE', 'CUSTOM_RESPONSE', 'CUSTOM_RESPONSE_BODY', 'JSON_MATCH_PATTERN', 'JSON_MATCH_SCOPE', 'BODY_PARSING_FALLBACK_BEHAVIOR', 'LOGGING_FILTER', 'FILTER_CONDITION', 'EXPIRE_TIMESTAMP', 'CHANGE_PROPAGATION_STATUS', 'ASSOCIABLE_RESOURCE', 'LOG_DESTINATION', 'MANAGED_RULE_GROUP_CONFIG', 'PAYLOAD_TYPE', 'HEADER_MATCH_PATTERN', 'COOKIE_MATCH_PATTERN', 'MAP_MATCH_SCOPE', 'OVERSIZE_HANDLING', 'CHALLENGE_CONFIG', 'TOKEN_DOMAIN', 'ATP_RULE_SET_RESPONSE_INSPECTION', 'ASSOCIATED_RESOURCE_TYPE', 'SCOPE_DOWN', 'CUSTOM_KEYS', 'ACP_RULE_SET_RESPONSE_INSPECTION', ], ], 'ParameterExceptionParameter' => [ 'type' => 'string', 'min' => 1, ], 'PasswordField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'PayloadType' => [ 'type' => 'string', 'enum' => [ 'JSON', 'FORM_ENCODED', ], ], 'PhoneNumberField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'PhoneNumberFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberField', ], ], 'Platform' => [ 'type' => 'string', 'enum' => [ 'IOS', 'ANDROID', ], ], 'PolicyString' => [ 'type' => 'string', 'max' => 395000, 'min' => 1, 'pattern' => '.*\\S.*', ], 'PopulationSize' => [ 'type' => 'long', ], 'PositionalConstraint' => [ 'type' => 'string', 'enum' => [ 'EXACTLY', 'STARTS_WITH', 'ENDS_WITH', 'CONTAINS', 'CONTAINS_WORD', ], ], 'ProductDescription' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductLink' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductTitle' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.*\\S.*', ], 'PublishedVersions' => [ 'type' => 'map', 'key' => [ 'shape' => 'VersionKeyString', ], 'value' => [ 'shape' => 'ManagedRuleSetVersion', ], ], 'PutLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'LoggingConfiguration', ], 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutManagedRuleSetVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'RecommendedVersion' => [ 'shape' => 'VersionKeyString', ], 'VersionsToPublish' => [ 'shape' => 'VersionsToPublish', ], ], ], 'PutManagedRuleSetVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'PutPermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Policy', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Policy' => [ 'shape' => 'PolicyString', ], ], ], 'PutPermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'QueryString' => [ 'type' => 'structure', 'members' => [], ], 'RateBasedStatement' => [ 'type' => 'structure', 'required' => [ 'Limit', 'AggregateKeyType', ], 'members' => [ 'Limit' => [ 'shape' => 'RateLimit', ], 'EvaluationWindowSec' => [ 'shape' => 'EvaluationWindowSec', ], 'AggregateKeyType' => [ 'shape' => 'RateBasedStatementAggregateKeyType', ], 'ScopeDownStatement' => [ 'shape' => 'Statement', ], 'ForwardedIPConfig' => [ 'shape' => 'ForwardedIPConfig', ], 'CustomKeys' => [ 'shape' => 'RateBasedStatementCustomKeys', ], ], ], 'RateBasedStatementAggregateKeyType' => [ 'type' => 'string', 'enum' => [ 'IP', 'FORWARDED_IP', 'CUSTOM_KEYS', 'CONSTANT', ], ], 'RateBasedStatementCustomKey' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'RateLimitHeader', ], 'Cookie' => [ 'shape' => 'RateLimitCookie', ], 'QueryArgument' => [ 'shape' => 'RateLimitQueryArgument', ], 'QueryString' => [ 'shape' => 'RateLimitQueryString', ], 'HTTPMethod' => [ 'shape' => 'RateLimitHTTPMethod', ], 'ForwardedIP' => [ 'shape' => 'RateLimitForwardedIP', ], 'IP' => [ 'shape' => 'RateLimitIP', ], 'LabelNamespace' => [ 'shape' => 'RateLimitLabelNamespace', ], 'UriPath' => [ 'shape' => 'RateLimitUriPath', ], ], ], 'RateBasedStatementCustomKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'RateBasedStatementCustomKey', ], 'max' => 5, ], 'RateBasedStatementManagedKeysIPSet' => [ 'type' => 'structure', 'members' => [ 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], ], ], 'RateLimit' => [ 'type' => 'long', 'max' => 2000000000, 'min' => 100, ], 'RateLimitCookie' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitForwardedIP' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitHTTPMethod' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitIP' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitLabelNamespace' => [ 'type' => 'structure', 'required' => [ 'Namespace', ], 'members' => [ 'Namespace' => [ 'shape' => 'LabelNamespace', ], ], ], 'RateLimitQueryArgument' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitQueryString' => [ 'type' => 'structure', 'required' => [ 'TextTransformations', ], 'members' => [ 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitUriPath' => [ 'type' => 'structure', 'required' => [ 'TextTransformations', ], 'members' => [ 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RedactedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldToMatch', ], 'max' => 100, ], 'Regex' => [ 'type' => 'structure', 'members' => [ 'RegexString' => [ 'shape' => 'RegexPatternString', ], ], ], 'RegexMatchStatement' => [ 'type' => 'structure', 'required' => [ 'RegexString', 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'RegexString' => [ 'shape' => 'RegexPatternString', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RegexPatternSet' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], ], ], 'RegexPatternSetReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RegexPatternSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegexPatternSetSummary', ], ], 'RegexPatternSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'RegexPatternString' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'RegistrationPagePathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'RegularExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Regex', ], ], 'ReleaseNotes' => [ 'type' => 'string', ], 'ReleaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReleaseSummary', ], ], 'ReleaseSummary' => [ 'type' => 'structure', 'members' => [ 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RequestBody' => [ 'type' => 'map', 'key' => [ 'shape' => 'AssociatedResourceType', ], 'value' => [ 'shape' => 'RequestBodyAssociatedResourceTypeConfig', ], ], 'RequestBodyAssociatedResourceTypeConfig' => [ 'type' => 'structure', 'required' => [ 'DefaultSizeInspectionLimit', ], 'members' => [ 'DefaultSizeInspectionLimit' => [ 'shape' => 'SizeInspectionLimit', ], ], ], 'RequestInspection' => [ 'type' => 'structure', 'required' => [ 'PayloadType', 'UsernameField', 'PasswordField', ], 'members' => [ 'PayloadType' => [ 'shape' => 'PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', ], ], ], 'RequestInspectionACFP' => [ 'type' => 'structure', 'required' => [ 'PayloadType', ], 'members' => [ 'PayloadType' => [ 'shape' => 'PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', ], 'EmailField' => [ 'shape' => 'EmailField', ], 'PhoneNumberFields' => [ 'shape' => 'PhoneNumberFields', ], 'AddressFields' => [ 'shape' => 'AddressFields', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*\\S.*', ], 'ResourceArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'APPLICATION_LOAD_BALANCER', 'API_GATEWAY', 'APPSYNC', 'COGNITO_USER_POOL', 'APP_RUNNER_SERVICE', 'VERIFIED_ACCESS_INSTANCE', ], ], 'ResponseCode' => [ 'type' => 'integer', ], 'ResponseContent' => [ 'type' => 'string', 'max' => 10240, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'ResponseContentType' => [ 'type' => 'string', 'enum' => [ 'TEXT_PLAIN', 'TEXT_HTML', 'APPLICATION_JSON', ], ], 'ResponseInspection' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'ResponseInspectionStatusCode', ], 'Header' => [ 'shape' => 'ResponseInspectionHeader', ], 'BodyContains' => [ 'shape' => 'ResponseInspectionBodyContains', ], 'Json' => [ 'shape' => 'ResponseInspectionJson', ], ], ], 'ResponseInspectionBodyContains' => [ 'type' => 'structure', 'required' => [ 'SuccessStrings', 'FailureStrings', ], 'members' => [ 'SuccessStrings' => [ 'shape' => 'ResponseInspectionBodyContainsSuccessStrings', ], 'FailureStrings' => [ 'shape' => 'ResponseInspectionBodyContainsFailureStrings', ], ], ], 'ResponseInspectionBodyContainsFailureStrings' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionBodyContainsSuccessStrings' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'SuccessValues', 'FailureValues', ], 'members' => [ 'Name' => [ 'shape' => 'ResponseInspectionHeaderName', ], 'SuccessValues' => [ 'shape' => 'ResponseInspectionHeaderSuccessValues', ], 'FailureValues' => [ 'shape' => 'ResponseInspectionHeaderFailureValues', ], ], ], 'ResponseInspectionHeaderFailureValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 3, 'min' => 1, ], 'ResponseInspectionHeaderName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ResponseInspectionHeaderSuccessValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 3, 'min' => 1, ], 'ResponseInspectionJson' => [ 'type' => 'structure', 'required' => [ 'Identifier', 'SuccessValues', 'FailureValues', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], 'SuccessValues' => [ 'shape' => 'ResponseInspectionJsonSuccessValues', ], 'FailureValues' => [ 'shape' => 'ResponseInspectionJsonFailureValues', ], ], ], 'ResponseInspectionJsonFailureValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionJsonSuccessValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionStatusCode' => [ 'type' => 'structure', 'required' => [ 'SuccessCodes', 'FailureCodes', ], 'members' => [ 'SuccessCodes' => [ 'shape' => 'ResponseInspectionStatusCodeSuccessCodes', ], 'FailureCodes' => [ 'shape' => 'ResponseInspectionStatusCodeFailureCodes', ], ], ], 'ResponseInspectionStatusCodeFailureCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureCode', ], 'max' => 10, 'min' => 1, ], 'ResponseInspectionStatusCodeSuccessCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessCode', ], 'max' => 10, 'min' => 1, ], 'ResponseStatusCode' => [ 'type' => 'integer', 'max' => 599, 'min' => 200, ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Name', 'Priority', 'Statement', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Priority' => [ 'shape' => 'RulePriority', ], 'Statement' => [ 'shape' => 'Statement', ], 'Action' => [ 'shape' => 'RuleAction', ], 'OverrideAction' => [ 'shape' => 'OverrideAction', ], 'RuleLabels' => [ 'shape' => 'Labels', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], ], ], 'RuleAction' => [ 'type' => 'structure', 'members' => [ 'Block' => [ 'shape' => 'BlockAction', ], 'Allow' => [ 'shape' => 'AllowAction', ], 'Count' => [ 'shape' => 'CountAction', ], 'Captcha' => [ 'shape' => 'CaptchaAction', ], 'Challenge' => [ 'shape' => 'ChallengeAction', ], ], ], 'RuleActionOverride' => [ 'type' => 'structure', 'required' => [ 'Name', 'ActionToUse', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'ActionToUse' => [ 'shape' => 'RuleAction', ], ], ], 'RuleActionOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleActionOverride', ], 'max' => 100, ], 'RuleGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Capacity', 'ARN', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'AvailableLabels' => [ 'shape' => 'LabelSummaries', ], 'ConsumedLabels' => [ 'shape' => 'LabelSummaries', ], ], ], 'RuleGroupReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'ExcludedRules' => [ 'shape' => 'ExcludedRules', ], 'RuleActionOverrides' => [ 'shape' => 'RuleActionOverrides', ], ], ], 'RuleGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleGroupSummary', ], ], 'RuleGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'RulePriority' => [ 'type' => 'integer', 'min' => 0, ], 'RuleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleSummary', ], ], 'RuleSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Action' => [ 'shape' => 'RuleAction', ], ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], ], 'SampleWeight' => [ 'type' => 'long', 'min' => 0, ], 'SampledHTTPRequest' => [ 'type' => 'structure', 'required' => [ 'Request', 'Weight', ], 'members' => [ 'Request' => [ 'shape' => 'HTTPRequest', ], 'Weight' => [ 'shape' => 'SampleWeight', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], 'Action' => [ 'shape' => 'Action', ], 'RuleNameWithinRuleGroup' => [ 'shape' => 'EntityName', ], 'RequestHeadersInserted' => [ 'shape' => 'HTTPHeaders', ], 'ResponseCodeSent' => [ 'shape' => 'ResponseStatusCode', ], 'Labels' => [ 'shape' => 'Labels', ], 'CaptchaResponse' => [ 'shape' => 'CaptchaResponse', ], 'ChallengeResponse' => [ 'shape' => 'ChallengeResponse', ], 'OverriddenAction' => [ 'shape' => 'Action', ], ], ], 'SampledHTTPRequests' => [ 'type' => 'list', 'member' => [ 'shape' => 'SampledHTTPRequest', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'CLOUDFRONT', 'REGIONAL', ], ], 'SearchString' => [ 'type' => 'blob', ], 'SensitivityLevel' => [ 'type' => 'string', 'enum' => [ 'LOW', 'HIGH', ], ], 'SingleCookieName' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '.*\\S.*', ], 'SingleHeader' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], ], ], 'SingleQueryArgument' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], ], ], 'Size' => [ 'type' => 'long', 'max' => 21474836480, 'min' => 0, ], 'SizeConstraintStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'ComparisonOperator', 'Size', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'Size' => [ 'shape' => 'Size', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'SizeInspectionLimit' => [ 'type' => 'string', 'enum' => [ 'KB_16', 'KB_32', 'KB_48', 'KB_64', ], ], 'SolveTimestamp' => [ 'type' => 'long', ], 'SourceType' => [ 'type' => 'string', ], 'SqliMatchStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], 'SensitivityLevel' => [ 'shape' => 'SensitivityLevel', ], ], ], 'Statement' => [ 'type' => 'structure', 'members' => [ 'ByteMatchStatement' => [ 'shape' => 'ByteMatchStatement', ], 'SqliMatchStatement' => [ 'shape' => 'SqliMatchStatement', ], 'XssMatchStatement' => [ 'shape' => 'XssMatchStatement', ], 'SizeConstraintStatement' => [ 'shape' => 'SizeConstraintStatement', ], 'GeoMatchStatement' => [ 'shape' => 'GeoMatchStatement', ], 'RuleGroupReferenceStatement' => [ 'shape' => 'RuleGroupReferenceStatement', ], 'IPSetReferenceStatement' => [ 'shape' => 'IPSetReferenceStatement', ], 'RegexPatternSetReferenceStatement' => [ 'shape' => 'RegexPatternSetReferenceStatement', ], 'RateBasedStatement' => [ 'shape' => 'RateBasedStatement', ], 'AndStatement' => [ 'shape' => 'AndStatement', ], 'OrStatement' => [ 'shape' => 'OrStatement', ], 'NotStatement' => [ 'shape' => 'NotStatement', ], 'ManagedRuleGroupStatement' => [ 'shape' => 'ManagedRuleGroupStatement', ], 'LabelMatchStatement' => [ 'shape' => 'LabelMatchStatement', ], 'RegexMatchStatement' => [ 'shape' => 'RegexMatchStatement', ], ], ], 'Statements' => [ 'type' => 'list', 'member' => [ 'shape' => 'Statement', ], ], 'String' => [ 'type' => 'string', ], 'SuccessCode' => [ 'type' => 'integer', 'max' => 999, 'min' => 0, ], 'SuccessValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '.*\\S.*', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagInfoForResource' => [ 'type' => 'structure', 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TextTransformation' => [ 'type' => 'structure', 'required' => [ 'Priority', 'Type', ], 'members' => [ 'Priority' => [ 'shape' => 'TextTransformationPriority', ], 'Type' => [ 'shape' => 'TextTransformationType', ], ], ], 'TextTransformationPriority' => [ 'type' => 'integer', 'min' => 0, ], 'TextTransformationType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'COMPRESS_WHITE_SPACE', 'HTML_ENTITY_DECODE', 'LOWERCASE', 'CMD_LINE', 'URL_DECODE', 'BASE64_DECODE', 'HEX_DECODE', 'MD5', 'REPLACE_COMMENTS', 'ESCAPE_SEQ_DECODE', 'SQL_HEX_DECODE', 'CSS_DECODE', 'JS_DECODE', 'NORMALIZE_PATH', 'NORMALIZE_PATH_WIN', 'REMOVE_NULLS', 'REPLACE_NULLS', 'BASE64_DECODE_EXT', 'URL_DECODE_UNI', 'UTF8_TO_UNICODE', ], ], 'TextTransformations' => [ 'type' => 'list', 'member' => [ 'shape' => 'TextTransformation', ], 'min' => 1, ], 'TimeWindow' => [ 'type' => 'structure', 'required' => [ 'StartTime', 'EndTime', ], 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'TimeWindowDay' => [ 'type' => 'integer', 'min' => 1, ], 'TimeWindowSecond' => [ 'type' => 'long', 'max' => 259200, 'min' => 60, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TokenDomain' => [ 'type' => 'string', 'max' => 253, 'min' => 1, 'pattern' => '^[\\w\\.\\-/]+$', ], 'TokenDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'TokenDomain', ], ], 'URIString' => [ 'type' => 'string', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'Addresses', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateManagedRuleSetVersionExpiryDateRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', 'VersionToExpire', 'ExpiryTimestamp', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'VersionToExpire' => [ 'shape' => 'VersionKeyString', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateManagedRuleSetVersionExpiryDateResponse' => [ 'type' => 'structure', 'members' => [ 'ExpiringVersion' => [ 'shape' => 'VersionKeyString', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'RegularExpressionList', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'VisibilityConfig', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], ], ], 'UpdateRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'DefaultAction', 'VisibilityConfig', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'UpdateWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UriPath' => [ 'type' => 'structure', 'members' => [], ], 'UsernameField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'VendorName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'VersionKeyString' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[\\w#:\\.\\-/]+$', ], 'VersionToPublish' => [ 'type' => 'structure', 'members' => [ 'AssociatedRuleGroupArn' => [ 'shape' => 'ResourceArn', ], 'ForecastedLifetime' => [ 'shape' => 'TimeWindowDay', ], ], ], 'VersionsToPublish' => [ 'type' => 'map', 'key' => [ 'shape' => 'VersionKeyString', ], 'value' => [ 'shape' => 'VersionToPublish', ], ], 'VisibilityConfig' => [ 'type' => 'structure', 'required' => [ 'SampledRequestsEnabled', 'CloudWatchMetricsEnabled', 'MetricName', ], 'members' => [ 'SampledRequestsEnabled' => [ 'shape' => 'Boolean', ], 'CloudWatchMetricsEnabled' => [ 'shape' => 'Boolean', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'WAFAssociatedItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFConfigurationWarningException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFDuplicateItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFExpiredManagedRuleGroupVersionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'WAFInvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'Field' => [ 'shape' => 'ParameterExceptionField', ], 'Parameter' => [ 'shape' => 'ParameterExceptionParameter', ], 'Reason' => [ 'shape' => 'ErrorReason', ], ], 'exception' => true, ], 'WAFInvalidPermissionPolicyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInvalidResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFLimitsExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], 'exception' => true, ], 'WAFLogDestinationPermissionIssueException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFNonexistentItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFOptimisticLockException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFServiceLinkedRoleErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFSubscriptionNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFTagOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFTagOperationInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'WAFUnavailableEntityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFUnsupportedAggregateKeyTypeException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WebACL' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', 'DefaultAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Capacity' => [ 'shape' => 'ConsumedCapacity', ], 'PreProcessFirewallManagerRuleGroups' => [ 'shape' => 'FirewallManagerRuleGroups', ], 'PostProcessFirewallManagerRuleGroups' => [ 'shape' => 'FirewallManagerRuleGroups', ], 'ManagedByFirewallManager' => [ 'shape' => 'Boolean', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'WebACLSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'WebACLSummary', ], ], 'WebACLSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'XssMatchStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2019-07-29', 'endpointPrefix' => 'wafv2', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'WAFV2', 'serviceFullName' => 'AWS WAFV2', 'serviceId' => 'WAFV2', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSWAF_20190729', 'uid' => 'wafv2-2019-07-29', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AssociateWebACL' => [ 'name' => 'AssociateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateWebACLRequest', ], 'output' => [ 'shape' => 'AssociateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CheckCapacity' => [ 'name' => 'CheckCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CheckCapacityRequest', ], 'output' => [ 'shape' => 'CheckCapacityResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateAPIKey' => [ 'name' => 'CreateAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAPIKeyRequest', ], 'output' => [ 'shape' => 'CreateAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFLimitsExceededException', ], ], ], 'CreateIPSet' => [ 'name' => 'CreateIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateIPSetRequest', ], 'output' => [ 'shape' => 'CreateIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateRegexPatternSet' => [ 'name' => 'CreateRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRegexPatternSetRequest', ], 'output' => [ 'shape' => 'CreateRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateRuleGroup' => [ 'name' => 'CreateRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRuleGroupRequest', ], 'output' => [ 'shape' => 'CreateRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'CreateWebACL' => [ 'name' => 'CreateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWebACLRequest', ], 'output' => [ 'shape' => 'CreateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFConfigurationWarningException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], ], ], 'DeleteAPIKey' => [ 'name' => 'DeleteAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAPIKeyRequest', ], 'output' => [ 'shape' => 'DeleteAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteFirewallManagerRuleGroups' => [ 'name' => 'DeleteFirewallManagerRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFirewallManagerRuleGroupsRequest', ], 'output' => [ 'shape' => 'DeleteFirewallManagerRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteIPSet' => [ 'name' => 'DeleteIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteIPSetRequest', ], 'output' => [ 'shape' => 'DeleteIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteLoggingConfiguration' => [ 'name' => 'DeleteLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeletePermissionPolicy' => [ 'name' => 'DeletePermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePermissionPolicyRequest', ], 'output' => [ 'shape' => 'DeletePermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DeleteRegexPatternSet' => [ 'name' => 'DeleteRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRegexPatternSetRequest', ], 'output' => [ 'shape' => 'DeleteRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteRuleGroup' => [ 'name' => 'DeleteRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRuleGroupRequest', ], 'output' => [ 'shape' => 'DeleteRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DeleteWebACL' => [ 'name' => 'DeleteWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWebACLRequest', ], 'output' => [ 'shape' => 'DeleteWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFAssociatedItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'DescribeAllManagedProducts' => [ 'name' => 'DescribeAllManagedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAllManagedProductsRequest', ], 'output' => [ 'shape' => 'DescribeAllManagedProductsResponse', ], 'errors' => [ [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DescribeManagedProductsByVendor' => [ 'name' => 'DescribeManagedProductsByVendor', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeManagedProductsByVendorRequest', ], 'output' => [ 'shape' => 'DescribeManagedProductsByVendorResponse', ], 'errors' => [ [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'DescribeManagedRuleGroup' => [ 'name' => 'DescribeManagedRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeManagedRuleGroupRequest', ], 'output' => [ 'shape' => 'DescribeManagedRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], ], ], 'DisassociateWebACL' => [ 'name' => 'DisassociateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateWebACLRequest', ], 'output' => [ 'shape' => 'DisassociateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GenerateMobileSdkReleaseUrl' => [ 'name' => 'GenerateMobileSdkReleaseUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GenerateMobileSdkReleaseUrlRequest', ], 'output' => [ 'shape' => 'GenerateMobileSdkReleaseUrlResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetDecryptedAPIKey' => [ 'name' => 'GetDecryptedAPIKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDecryptedAPIKeyRequest', ], 'output' => [ 'shape' => 'GetDecryptedAPIKeyResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInvalidResourceException', ], ], ], 'GetIPSet' => [ 'name' => 'GetIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetIPSetRequest', ], 'output' => [ 'shape' => 'GetIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetLoggingConfiguration' => [ 'name' => 'GetLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'GetLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetManagedRuleSet' => [ 'name' => 'GetManagedRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetManagedRuleSetRequest', ], 'output' => [ 'shape' => 'GetManagedRuleSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetMobileSdkRelease' => [ 'name' => 'GetMobileSdkRelease', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileSdkReleaseRequest', ], 'output' => [ 'shape' => 'GetMobileSdkReleaseResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetPermissionPolicy' => [ 'name' => 'GetPermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPermissionPolicyRequest', ], 'output' => [ 'shape' => 'GetPermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'GetRateBasedStatementManagedKeys' => [ 'name' => 'GetRateBasedStatementManagedKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRateBasedStatementManagedKeysRequest', ], 'output' => [ 'shape' => 'GetRateBasedStatementManagedKeysResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFUnsupportedAggregateKeyTypeException', ], ], ], 'GetRegexPatternSet' => [ 'name' => 'GetRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegexPatternSetRequest', ], 'output' => [ 'shape' => 'GetRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetRuleGroup' => [ 'name' => 'GetRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRuleGroupRequest', ], 'output' => [ 'shape' => 'GetRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetSampledRequests' => [ 'name' => 'GetSampledRequests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSampledRequestsRequest', ], 'output' => [ 'shape' => 'GetSampledRequestsResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], ], ], 'GetWebACL' => [ 'name' => 'GetWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetWebACLRequest', ], 'output' => [ 'shape' => 'GetWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'GetWebACLForResource' => [ 'name' => 'GetWebACLForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetWebACLForResourceRequest', ], 'output' => [ 'shape' => 'GetWebACLForResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListAPIKeys' => [ 'name' => 'ListAPIKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAPIKeysRequest', ], 'output' => [ 'shape' => 'ListAPIKeysResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFInvalidResourceException', ], ], ], 'ListAvailableManagedRuleGroupVersions' => [ 'name' => 'ListAvailableManagedRuleGroupVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailableManagedRuleGroupVersionsRequest', ], 'output' => [ 'shape' => 'ListAvailableManagedRuleGroupVersionsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListAvailableManagedRuleGroups' => [ 'name' => 'ListAvailableManagedRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailableManagedRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListAvailableManagedRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListIPSets' => [ 'name' => 'ListIPSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListIPSetsRequest', ], 'output' => [ 'shape' => 'ListIPSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListLoggingConfigurations' => [ 'name' => 'ListLoggingConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLoggingConfigurationsRequest', ], 'output' => [ 'shape' => 'ListLoggingConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListManagedRuleSets' => [ 'name' => 'ListManagedRuleSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListManagedRuleSetsRequest', ], 'output' => [ 'shape' => 'ListManagedRuleSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListMobileSdkReleases' => [ 'name' => 'ListMobileSdkReleases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileSdkReleasesRequest', ], 'output' => [ 'shape' => 'ListMobileSdkReleasesResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListRegexPatternSets' => [ 'name' => 'ListRegexPatternSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRegexPatternSetsRequest', ], 'output' => [ 'shape' => 'ListRegexPatternSetsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListResourcesForWebACL' => [ 'name' => 'ListResourcesForWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesForWebACLRequest', ], 'output' => [ 'shape' => 'ListResourcesForWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListRuleGroups' => [ 'name' => 'ListRuleGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRuleGroupsRequest', ], 'output' => [ 'shape' => 'ListRuleGroupsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'ListWebACLs' => [ 'name' => 'ListWebACLs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWebACLsRequest', ], 'output' => [ 'shape' => 'ListWebACLsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'PutLoggingConfiguration' => [ 'name' => 'PutLoggingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutLoggingConfigurationRequest', ], 'output' => [ 'shape' => 'PutLoggingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFServiceLinkedRoleErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFLogDestinationPermissionIssueException', ], ], ], 'PutManagedRuleSetVersions' => [ 'name' => 'PutManagedRuleSetVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutManagedRuleSetVersionsRequest', ], 'output' => [ 'shape' => 'PutManagedRuleSetVersionsResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'PutPermissionPolicy' => [ 'name' => 'PutPermissionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPermissionPolicyRequest', ], 'output' => [ 'shape' => 'PutPermissionPolicyResponse', ], 'errors' => [ [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFInvalidPermissionPolicyException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFTagOperationException', ], [ 'shape' => 'WAFTagOperationInternalErrorException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateIPSet' => [ 'name' => 'UpdateIPSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateIPSetRequest', ], 'output' => [ 'shape' => 'UpdateIPSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateManagedRuleSetVersionExpiryDate' => [ 'name' => 'UpdateManagedRuleSetVersionExpiryDate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateManagedRuleSetVersionExpiryDateRequest', ], 'output' => [ 'shape' => 'UpdateManagedRuleSetVersionExpiryDateResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateRegexPatternSet' => [ 'name' => 'UpdateRegexPatternSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRegexPatternSetRequest', ], 'output' => [ 'shape' => 'UpdateRegexPatternSetResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidOperationException', ], ], ], 'UpdateRuleGroup' => [ 'name' => 'UpdateRuleGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRuleGroupRequest', ], 'output' => [ 'shape' => 'UpdateRuleGroupResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFConfigurationWarningException', ], ], ], 'UpdateWebACL' => [ 'name' => 'UpdateWebACL', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWebACLRequest', ], 'output' => [ 'shape' => 'UpdateWebACLResponse', ], 'errors' => [ [ 'shape' => 'WAFInternalErrorException', ], [ 'shape' => 'WAFInvalidParameterException', ], [ 'shape' => 'WAFNonexistentItemException', ], [ 'shape' => 'WAFDuplicateItemException', ], [ 'shape' => 'WAFOptimisticLockException', ], [ 'shape' => 'WAFLimitsExceededException', ], [ 'shape' => 'WAFInvalidResourceException', ], [ 'shape' => 'WAFUnavailableEntityException', ], [ 'shape' => 'WAFSubscriptionNotFoundException', ], [ 'shape' => 'WAFInvalidOperationException', ], [ 'shape' => 'WAFExpiredManagedRuleGroupVersionException', ], [ 'shape' => 'WAFConfigurationWarningException', ], ], ], ], 'shapes' => [ 'APIKey' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*\\S.*', ], 'APIKeySummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'APIKeySummary', ], ], 'APIKeySummary' => [ 'type' => 'structure', 'members' => [ 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'APIKey' => [ 'shape' => 'APIKey', ], 'CreationTimestamp' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'APIKeyVersion', ], ], ], 'APIKeyTokenDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'TokenDomain', ], 'min' => 1, ], 'APIKeyVersion' => [ 'type' => 'integer', 'min' => 0, ], 'AWSManagedRulesACFPRuleSet' => [ 'type' => 'structure', 'required' => [ 'CreationPath', 'RegistrationPagePath', 'RequestInspection', ], 'members' => [ 'CreationPath' => [ 'shape' => 'CreationPathString', ], 'RegistrationPagePath' => [ 'shape' => 'RegistrationPagePathString', ], 'RequestInspection' => [ 'shape' => 'RequestInspectionACFP', ], 'ResponseInspection' => [ 'shape' => 'ResponseInspection', ], 'EnableRegexInPath' => [ 'shape' => 'Boolean', ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'type' => 'structure', 'required' => [ 'LoginPath', ], 'members' => [ 'LoginPath' => [ 'shape' => 'String', ], 'RequestInspection' => [ 'shape' => 'RequestInspection', ], 'ResponseInspection' => [ 'shape' => 'ResponseInspection', ], 'EnableRegexInPath' => [ 'shape' => 'Boolean', ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'type' => 'structure', 'required' => [ 'InspectionLevel', ], 'members' => [ 'InspectionLevel' => [ 'shape' => 'InspectionLevel', ], 'EnableMachineLearning' => [ 'shape' => 'EnableMachineLearning', ], ], ], 'Action' => [ 'type' => 'string', ], 'ActionCondition' => [ 'type' => 'structure', 'required' => [ 'Action', ], 'members' => [ 'Action' => [ 'shape' => 'ActionValue', ], ], ], 'ActionValue' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'BLOCK', 'COUNT', 'CAPTCHA', 'CHALLENGE', 'EXCLUDED_AS_COUNT', ], ], 'AddressField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'AddressFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddressField', ], ], 'All' => [ 'type' => 'structure', 'members' => [], ], 'AllQueryArguments' => [ 'type' => 'structure', 'members' => [], ], 'AllowAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'AndStatement' => [ 'type' => 'structure', 'required' => [ 'Statements', ], 'members' => [ 'Statements' => [ 'shape' => 'Statements', ], ], ], 'AssociateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', 'ResourceArn', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'AssociateWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociatedResourceType' => [ 'type' => 'string', 'enum' => [ 'CLOUDFRONT', 'API_GATEWAY', 'COGNITO_USER_POOL', 'APP_RUNNER_SERVICE', 'VERIFIED_ACCESS_INSTANCE', ], ], 'AssociationConfig' => [ 'type' => 'structure', 'members' => [ 'RequestBody' => [ 'shape' => 'RequestBody', ], ], ], 'BlockAction' => [ 'type' => 'structure', 'members' => [ 'CustomResponse' => [ 'shape' => 'CustomResponse', ], ], ], 'Body' => [ 'type' => 'structure', 'members' => [ 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'BodyParsingFallbackBehavior' => [ 'type' => 'string', 'enum' => [ 'MATCH', 'NO_MATCH', 'EVALUATE_AS_STRING', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ByteMatchStatement' => [ 'type' => 'structure', 'required' => [ 'SearchString', 'FieldToMatch', 'TextTransformations', 'PositionalConstraint', ], 'members' => [ 'SearchString' => [ 'shape' => 'SearchString', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], 'PositionalConstraint' => [ 'shape' => 'PositionalConstraint', ], ], ], 'CapacityUnit' => [ 'type' => 'long', 'min' => 1, ], 'CaptchaAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'CaptchaConfig' => [ 'type' => 'structure', 'members' => [ 'ImmunityTimeProperty' => [ 'shape' => 'ImmunityTimeProperty', ], ], ], 'CaptchaResponse' => [ 'type' => 'structure', 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseCode', ], 'SolveTimestamp' => [ 'shape' => 'SolveTimestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'ChallengeAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'ChallengeConfig' => [ 'type' => 'structure', 'members' => [ 'ImmunityTimeProperty' => [ 'shape' => 'ImmunityTimeProperty', ], ], ], 'ChallengeResponse' => [ 'type' => 'structure', 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseCode', ], 'SolveTimestamp' => [ 'shape' => 'SolveTimestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'CheckCapacityRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'Rules', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'Rules' => [ 'shape' => 'Rules', ], ], ], 'CheckCapacityResponse' => [ 'type' => 'structure', 'members' => [ 'Capacity' => [ 'shape' => 'ConsumedCapacity', ], ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'EQ', 'NE', 'LE', 'LT', 'GE', 'GT', ], ], 'Condition' => [ 'type' => 'structure', 'members' => [ 'ActionCondition' => [ 'shape' => 'ActionCondition', ], 'LabelNameCondition' => [ 'shape' => 'LabelNameCondition', ], ], ], 'Conditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Condition', ], 'min' => 1, ], 'ConsumedCapacity' => [ 'type' => 'long', 'min' => 0, ], 'CookieMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedCookies' => [ 'shape' => 'CookieNames', ], 'ExcludedCookies' => [ 'shape' => 'CookieNames', ], ], ], 'CookieNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'SingleCookieName', ], 'max' => 199, 'min' => 1, ], 'Cookies' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', 'OversizeHandling', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'CookieMatchPattern', ], 'MatchScope' => [ 'shape' => 'MapMatchScope', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'CountAction' => [ 'type' => 'structure', 'members' => [ 'CustomRequestHandling' => [ 'shape' => 'CustomRequestHandling', ], ], ], 'Country' => [ 'type' => 'string', ], 'CountryCode' => [ 'type' => 'string', 'enum' => [ 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BQ', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CG', 'CD', 'CK', 'CR', 'CI', 'HR', 'CU', 'CW', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'SS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW', 'XK', ], ], 'CountryCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CountryCode', ], 'min' => 1, ], 'CreateAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'TokenDomains', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'TokenDomains' => [ 'shape' => 'APIKeyTokenDomains', ], ], ], 'CreateAPIKeyResponse' => [ 'type' => 'structure', 'members' => [ 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'CreateIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'IPAddressVersion', 'Addresses', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'IPSetSummary', ], ], ], 'CreateRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'RegularExpressionList', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'RegexPatternSetSummary', ], ], ], 'CreateRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Capacity', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], ], ], 'CreateRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'RuleGroupSummary', ], ], ], 'CreateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'DefaultAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'CreateWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'Summary' => [ 'shape' => 'WebACLSummary', ], ], ], 'CreationPathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'CustomHTTPHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'CustomHTTPHeaderName', ], 'Value' => [ 'shape' => 'CustomHTTPHeaderValue', ], ], ], 'CustomHTTPHeaderName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9._$-]+$', ], 'CustomHTTPHeaderValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'CustomHTTPHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomHTTPHeader', ], 'min' => 1, ], 'CustomRequestHandling' => [ 'type' => 'structure', 'required' => [ 'InsertHeaders', ], 'members' => [ 'InsertHeaders' => [ 'shape' => 'CustomHTTPHeaders', ], ], ], 'CustomResponse' => [ 'type' => 'structure', 'required' => [ 'ResponseCode', ], 'members' => [ 'ResponseCode' => [ 'shape' => 'ResponseStatusCode', ], 'CustomResponseBodyKey' => [ 'shape' => 'EntityName', ], 'ResponseHeaders' => [ 'shape' => 'CustomHTTPHeaders', ], ], ], 'CustomResponseBodies' => [ 'type' => 'map', 'key' => [ 'shape' => 'EntityName', ], 'value' => [ 'shape' => 'CustomResponseBody', ], 'min' => 1, ], 'CustomResponseBody' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'Content', ], 'members' => [ 'ContentType' => [ 'shape' => 'ResponseContentType', ], 'Content' => [ 'shape' => 'ResponseContent', ], ], ], 'DefaultAction' => [ 'type' => 'structure', 'members' => [ 'Block' => [ 'shape' => 'BlockAction', ], 'Allow' => [ 'shape' => 'AllowAction', ], ], ], 'DeleteAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'APIKey', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'DeleteAPIKeyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteFirewallManagerRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', 'WebACLLockToken', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'WebACLLockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteFirewallManagerRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextWebACLLockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteIPSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'DeleteLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeletePermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'DeletePermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteRuleGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'DeleteWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAllManagedProductsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], ], ], 'DescribeAllManagedProductsResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedProducts' => [ 'shape' => 'ManagedProductDescriptors', ], ], ], 'DescribeManagedProductsByVendorRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Scope' => [ 'shape' => 'Scope', ], ], ], 'DescribeManagedProductsByVendorResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedProducts' => [ 'shape' => 'ManagedProductDescriptors', ], ], ], 'DescribeManagedRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'VersionName' => [ 'shape' => 'VersionKeyString', ], ], ], 'DescribeManagedRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'VersionName' => [ 'shape' => 'VersionKeyString', ], 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'Rules' => [ 'shape' => 'RuleSummaries', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'AvailableLabels' => [ 'shape' => 'LabelSummaries', ], 'ConsumedLabels' => [ 'shape' => 'LabelSummaries', ], ], ], 'DisassociateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'DisassociateWebACLResponse' => [ 'type' => 'structure', 'members' => [], ], 'DownloadUrl' => [ 'type' => 'string', ], 'EmailField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'EnableMachineLearning' => [ 'type' => 'boolean', ], 'EntityDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$', ], 'EntityId' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$', ], 'EntityName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\w\\-]+$', ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorReason' => [ 'type' => 'string', ], 'EvaluationWindowSec' => [ 'type' => 'long', ], 'ExcludedRule' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], ], ], 'ExcludedRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExcludedRule', ], 'max' => 100, ], 'FailureCode' => [ 'type' => 'integer', 'max' => 999, 'min' => 0, ], 'FailureReason' => [ 'type' => 'string', 'enum' => [ 'TOKEN_MISSING', 'TOKEN_EXPIRED', 'TOKEN_INVALID', 'TOKEN_DOMAIN_MISMATCH', ], ], 'FailureValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '.*\\S.*', ], 'FallbackBehavior' => [ 'type' => 'string', 'enum' => [ 'MATCH', 'NO_MATCH', ], ], 'FieldIdentifier' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*\\S.*', ], 'FieldToMatch' => [ 'type' => 'structure', 'members' => [ 'SingleHeader' => [ 'shape' => 'SingleHeader', ], 'SingleQueryArgument' => [ 'shape' => 'SingleQueryArgument', ], 'AllQueryArguments' => [ 'shape' => 'AllQueryArguments', ], 'UriPath' => [ 'shape' => 'UriPath', ], 'QueryString' => [ 'shape' => 'QueryString', ], 'Body' => [ 'shape' => 'Body', ], 'Method' => [ 'shape' => 'Method', ], 'JsonBody' => [ 'shape' => 'JsonBody', ], 'Headers' => [ 'shape' => 'Headers', ], 'Cookies' => [ 'shape' => 'Cookies', ], 'HeaderOrder' => [ 'shape' => 'HeaderOrder', ], 'JA3Fingerprint' => [ 'shape' => 'JA3Fingerprint', ], ], ], 'FieldToMatchData' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*\\S.*', ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Behavior', 'Requirement', 'Conditions', ], 'members' => [ 'Behavior' => [ 'shape' => 'FilterBehavior', ], 'Requirement' => [ 'shape' => 'FilterRequirement', ], 'Conditions' => [ 'shape' => 'Conditions', ], ], ], 'FilterBehavior' => [ 'type' => 'string', 'enum' => [ 'KEEP', 'DROP', ], ], 'FilterRequirement' => [ 'type' => 'string', 'enum' => [ 'MEETS_ALL', 'MEETS_ANY', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'min' => 1, ], 'FirewallManagerRuleGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Priority', 'FirewallManagerStatement', 'OverrideAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Priority' => [ 'shape' => 'RulePriority', ], 'FirewallManagerStatement' => [ 'shape' => 'FirewallManagerStatement', ], 'OverrideAction' => [ 'shape' => 'OverrideAction', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], ], ], 'FirewallManagerRuleGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'FirewallManagerRuleGroup', ], ], 'FirewallManagerStatement' => [ 'type' => 'structure', 'members' => [ 'ManagedRuleGroupStatement' => [ 'shape' => 'ManagedRuleGroupStatement', ], 'RuleGroupReferenceStatement' => [ 'shape' => 'RuleGroupReferenceStatement', ], ], ], 'ForwardedIPConfig' => [ 'type' => 'structure', 'required' => [ 'HeaderName', 'FallbackBehavior', ], 'members' => [ 'HeaderName' => [ 'shape' => 'ForwardedIPHeaderName', ], 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], ], ], 'ForwardedIPHeaderName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ForwardedIPPosition' => [ 'type' => 'string', 'enum' => [ 'FIRST', 'LAST', 'ANY', ], ], 'GenerateMobileSdkReleaseUrlRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', 'ReleaseVersion', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'GenerateMobileSdkReleaseUrlResponse' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'DownloadUrl', ], ], ], 'GeoMatchStatement' => [ 'type' => 'structure', 'members' => [ 'CountryCodes' => [ 'shape' => 'CountryCodes', ], 'ForwardedIPConfig' => [ 'shape' => 'ForwardedIPConfig', ], ], ], 'GetDecryptedAPIKeyRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'APIKey', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'APIKey' => [ 'shape' => 'APIKey', ], ], ], 'GetDecryptedAPIKeyResponse' => [ 'type' => 'structure', 'members' => [ 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'CreationTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'GetIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'IPSet' => [ 'shape' => 'IPSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'GetLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'GetManagedRuleSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetManagedRuleSetResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedRuleSet' => [ 'shape' => 'ManagedRuleSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetMobileSdkReleaseRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', 'ReleaseVersion', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'GetMobileSdkReleaseResponse' => [ 'type' => 'structure', 'members' => [ 'MobileSdkRelease' => [ 'shape' => 'MobileSdkRelease', ], ], ], 'GetPermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetPermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'PolicyString', ], ], ], 'GetRateBasedStatementManagedKeysRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', 'WebACLName', 'WebACLId', 'RuleName', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'WebACLName' => [ 'shape' => 'EntityName', ], 'WebACLId' => [ 'shape' => 'EntityId', ], 'RuleGroupRuleName' => [ 'shape' => 'EntityName', ], 'RuleName' => [ 'shape' => 'EntityName', ], ], ], 'GetRateBasedStatementManagedKeysResponse' => [ 'type' => 'structure', 'members' => [ 'ManagedKeysIPV4' => [ 'shape' => 'RateBasedStatementManagedKeysIPSet', ], 'ManagedKeysIPV6' => [ 'shape' => 'RateBasedStatementManagedKeysIPSet', ], ], ], 'GetRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'RegexPatternSet' => [ 'shape' => 'RegexPatternSet', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetRuleGroupRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'GetRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'RuleGroup' => [ 'shape' => 'RuleGroup', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'GetSampledRequestsRequest' => [ 'type' => 'structure', 'required' => [ 'WebAclArn', 'RuleMetricName', 'Scope', 'TimeWindow', 'MaxItems', ], 'members' => [ 'WebAclArn' => [ 'shape' => 'ResourceArn', ], 'RuleMetricName' => [ 'shape' => 'MetricName', ], 'Scope' => [ 'shape' => 'Scope', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], 'MaxItems' => [ 'shape' => 'ListMaxItems', ], ], ], 'GetSampledRequestsResponse' => [ 'type' => 'structure', 'members' => [ 'SampledRequests' => [ 'shape' => 'SampledHTTPRequests', ], 'PopulationSize' => [ 'shape' => 'PopulationSize', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], ], ], 'GetWebACLForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], ], ], 'GetWebACLForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'WebACL' => [ 'shape' => 'WebACL', ], ], ], 'GetWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], ], ], 'GetWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'WebACL' => [ 'shape' => 'WebACL', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ApplicationIntegrationURL' => [ 'shape' => 'OutputUrl', ], ], ], 'HTTPHeader' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'HeaderName', ], 'Value' => [ 'shape' => 'HeaderValue', ], ], ], 'HTTPHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'HTTPHeader', ], ], 'HTTPMethod' => [ 'type' => 'string', ], 'HTTPRequest' => [ 'type' => 'structure', 'members' => [ 'ClientIP' => [ 'shape' => 'IPString', ], 'Country' => [ 'shape' => 'Country', ], 'URI' => [ 'shape' => 'URIString', ], 'Method' => [ 'shape' => 'HTTPMethod', ], 'HTTPVersion' => [ 'shape' => 'HTTPVersion', ], 'Headers' => [ 'shape' => 'HTTPHeaders', ], ], ], 'HTTPVersion' => [ 'type' => 'string', ], 'HeaderMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedHeaders' => [ 'shape' => 'HeaderNames', ], 'ExcludedHeaders' => [ 'shape' => 'HeaderNames', ], ], ], 'HeaderName' => [ 'type' => 'string', ], 'HeaderNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldToMatchData', ], 'max' => 199, 'min' => 1, ], 'HeaderOrder' => [ 'type' => 'structure', 'required' => [ 'OversizeHandling', ], 'members' => [ 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'HeaderValue' => [ 'type' => 'string', ], 'Headers' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', 'OversizeHandling', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'HeaderMatchPattern', ], 'MatchScope' => [ 'shape' => 'MapMatchScope', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'IPAddress' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '.*\\S.*', ], 'IPAddressVersion' => [ 'type' => 'string', 'enum' => [ 'IPV4', 'IPV6', ], ], 'IPAddresses' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPAddress', ], ], 'IPSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', 'IPAddressVersion', 'Addresses', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], ], ], 'IPSetForwardedIPConfig' => [ 'type' => 'structure', 'required' => [ 'HeaderName', 'FallbackBehavior', 'Position', ], 'members' => [ 'HeaderName' => [ 'shape' => 'ForwardedIPHeaderName', ], 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], 'Position' => [ 'shape' => 'ForwardedIPPosition', ], ], ], 'IPSetReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'IPSetForwardedIPConfig' => [ 'shape' => 'IPSetForwardedIPConfig', ], ], ], 'IPSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPSetSummary', ], ], 'IPSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'IPString' => [ 'type' => 'string', ], 'ImmunityTimeProperty' => [ 'type' => 'structure', 'required' => [ 'ImmunityTime', ], 'members' => [ 'ImmunityTime' => [ 'shape' => 'TimeWindowSecond', ], ], ], 'InspectionLevel' => [ 'type' => 'string', 'enum' => [ 'COMMON', 'TARGETED', ], ], 'JA3Fingerprint' => [ 'type' => 'structure', 'required' => [ 'FallbackBehavior', ], 'members' => [ 'FallbackBehavior' => [ 'shape' => 'FallbackBehavior', ], ], ], 'JsonBody' => [ 'type' => 'structure', 'required' => [ 'MatchPattern', 'MatchScope', ], 'members' => [ 'MatchPattern' => [ 'shape' => 'JsonMatchPattern', ], 'MatchScope' => [ 'shape' => 'JsonMatchScope', ], 'InvalidFallbackBehavior' => [ 'shape' => 'BodyParsingFallbackBehavior', ], 'OversizeHandling' => [ 'shape' => 'OversizeHandling', ], ], ], 'JsonMatchPattern' => [ 'type' => 'structure', 'members' => [ 'All' => [ 'shape' => 'All', ], 'IncludedPaths' => [ 'shape' => 'JsonPointerPaths', ], ], ], 'JsonMatchScope' => [ 'type' => 'string', 'enum' => [ 'ALL', 'KEY', 'VALUE', ], ], 'JsonPointerPath' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '([/])|([/](([^~])|(~[01]))+)', ], 'JsonPointerPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonPointerPath', ], 'min' => 1, ], 'Label' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'LabelName', ], ], ], 'LabelMatchKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+$', ], 'LabelMatchScope' => [ 'type' => 'string', 'enum' => [ 'LABEL', 'NAMESPACE', ], ], 'LabelMatchStatement' => [ 'type' => 'structure', 'required' => [ 'Scope', 'Key', ], 'members' => [ 'Scope' => [ 'shape' => 'LabelMatchScope', ], 'Key' => [ 'shape' => 'LabelMatchKey', ], ], ], 'LabelName' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+$', ], 'LabelNameCondition' => [ 'type' => 'structure', 'required' => [ 'LabelName', ], 'members' => [ 'LabelName' => [ 'shape' => 'LabelName', ], ], ], 'LabelNamespace' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^[0-9A-Za-z_\\-:]+:$', ], 'LabelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelSummary', ], ], 'LabelSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'LabelName', ], ], ], 'Labels' => [ 'type' => 'list', 'member' => [ 'shape' => 'Label', ], ], 'ListAPIKeysRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAPIKeysResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'APIKeySummaries' => [ 'shape' => 'APIKeySummaries', ], 'ApplicationIntegrationURL' => [ 'shape' => 'OutputUrl', ], ], ], 'ListAvailableManagedRuleGroupVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', 'Scope', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAvailableManagedRuleGroupVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Versions' => [ 'shape' => 'ManagedRuleGroupVersions', ], 'CurrentDefaultVersion' => [ 'shape' => 'VersionKeyString', ], ], ], 'ListAvailableManagedRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListAvailableManagedRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'ManagedRuleGroups' => [ 'shape' => 'ManagedRuleGroupSummaries', ], ], ], 'ListIPSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListIPSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'IPSets' => [ 'shape' => 'IPSetSummaries', ], ], ], 'ListLoggingConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'ListLoggingConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfigurations' => [ 'shape' => 'LoggingConfigurations', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], ], ], 'ListManagedRuleSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListManagedRuleSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'ManagedRuleSets' => [ 'shape' => 'ManagedRuleSetSummaries', ], ], ], 'ListMaxItems' => [ 'type' => 'long', 'max' => 500, 'min' => 1, ], 'ListMobileSdkReleasesRequest' => [ 'type' => 'structure', 'required' => [ 'Platform', ], 'members' => [ 'Platform' => [ 'shape' => 'Platform', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListMobileSdkReleasesResponse' => [ 'type' => 'structure', 'members' => [ 'ReleaseSummaries' => [ 'shape' => 'ReleaseSummaries', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], ], ], 'ListRegexPatternSetsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListRegexPatternSetsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'RegexPatternSets' => [ 'shape' => 'RegexPatternSetSummaries', ], ], ], 'ListResourcesForWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'WebACLArn', ], 'members' => [ 'WebACLArn' => [ 'shape' => 'ResourceArn', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], ], ], 'ListResourcesForWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArns' => [ 'shape' => 'ResourceArns', ], ], ], 'ListRuleGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListRuleGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'RuleGroups' => [ 'shape' => 'RuleGroupSummaries', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], 'ResourceARN' => [ 'shape' => 'ResourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'TagInfoForResource' => [ 'shape' => 'TagInfoForResource', ], ], ], 'ListWebACLsRequest' => [ 'type' => 'structure', 'required' => [ 'Scope', ], 'members' => [ 'Scope' => [ 'shape' => 'Scope', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Limit' => [ 'shape' => 'PaginationLimit', ], ], ], 'ListWebACLsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'NextMarker', ], 'WebACLs' => [ 'shape' => 'WebACLSummaries', ], ], ], 'LockToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$', ], 'LogDestinationConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], 'max' => 100, 'min' => 1, ], 'LogScope' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SECURITY_LAKE', ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'WAF_LOGS', ], ], 'LoggingConfiguration' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'LogDestinationConfigs', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'LogDestinationConfigs' => [ 'shape' => 'LogDestinationConfigs', ], 'RedactedFields' => [ 'shape' => 'RedactedFields', ], 'ManagedByFirewallManager' => [ 'shape' => 'Boolean', ], 'LoggingFilter' => [ 'shape' => 'LoggingFilter', ], 'LogType' => [ 'shape' => 'LogType', ], 'LogScope' => [ 'shape' => 'LogScope', ], ], ], 'LoggingConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoggingConfiguration', ], ], 'LoggingFilter' => [ 'type' => 'structure', 'required' => [ 'Filters', 'DefaultBehavior', ], 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'DefaultBehavior' => [ 'shape' => 'FilterBehavior', ], ], ], 'LoginPathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ManagedProductDescriptor' => [ 'type' => 'structure', 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'ManagedRuleSetName' => [ 'shape' => 'EntityName', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'ProductLink' => [ 'shape' => 'ProductLink', ], 'ProductTitle' => [ 'shape' => 'ProductTitle', ], 'ProductDescription' => [ 'shape' => 'ProductDescription', ], 'SnsTopicArn' => [ 'shape' => 'ResourceArn', ], 'IsVersioningSupported' => [ 'shape' => 'Boolean', ], 'IsAdvancedManagedRuleSet' => [ 'shape' => 'Boolean', ], ], ], 'ManagedProductDescriptors' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedProductDescriptor', ], ], 'ManagedRuleGroupConfig' => [ 'type' => 'structure', 'members' => [ 'LoginPath' => [ 'shape' => 'LoginPathString', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet LoginPath', ], 'PayloadType' => [ 'shape' => 'PayloadType', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', 'deprecated' => true, 'deprecatedMessage' => 'Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField', ], 'AWSManagedRulesBotControlRuleSet' => [ 'shape' => 'AWSManagedRulesBotControlRuleSet', ], 'AWSManagedRulesATPRuleSet' => [ 'shape' => 'AWSManagedRulesATPRuleSet', ], 'AWSManagedRulesACFPRuleSet' => [ 'shape' => 'AWSManagedRulesACFPRuleSet', ], ], ], 'ManagedRuleGroupConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupConfig', ], ], 'ManagedRuleGroupStatement' => [ 'type' => 'structure', 'required' => [ 'VendorName', 'Name', ], 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'Version' => [ 'shape' => 'VersionKeyString', ], 'ExcludedRules' => [ 'shape' => 'ExcludedRules', ], 'ScopeDownStatement' => [ 'shape' => 'Statement', ], 'ManagedRuleGroupConfigs' => [ 'shape' => 'ManagedRuleGroupConfigs', ], 'RuleActionOverrides' => [ 'shape' => 'RuleActionOverrides', ], ], ], 'ManagedRuleGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupSummary', ], ], 'ManagedRuleGroupSummary' => [ 'type' => 'structure', 'members' => [ 'VendorName' => [ 'shape' => 'VendorName', ], 'Name' => [ 'shape' => 'EntityName', ], 'VersioningSupported' => [ 'shape' => 'Boolean', ], 'Description' => [ 'shape' => 'EntityDescription', ], ], ], 'ManagedRuleGroupVersion' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'VersionKeyString', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ManagedRuleGroupVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleGroupVersion', ], ], 'ManagedRuleSet' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'PublishedVersions' => [ 'shape' => 'PublishedVersions', ], 'RecommendedVersion' => [ 'shape' => 'VersionKeyString', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], ], ], 'ManagedRuleSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedRuleSetSummary', ], ], 'ManagedRuleSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], ], ], 'ManagedRuleSetVersion' => [ 'type' => 'structure', 'members' => [ 'AssociatedRuleGroupArn' => [ 'shape' => 'ResourceArn', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'ForecastedLifetime' => [ 'shape' => 'TimeWindowDay', ], 'PublishTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MapMatchScope' => [ 'type' => 'string', 'enum' => [ 'ALL', 'KEY', 'VALUE', ], ], 'Method' => [ 'type' => 'structure', 'members' => [], ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^[\\w#:\\.\\-/]+$', ], 'MobileSdkRelease' => [ 'type' => 'structure', 'members' => [ 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'NextMarker' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NoneAction' => [ 'type' => 'structure', 'members' => [], ], 'NotStatement' => [ 'type' => 'structure', 'required' => [ 'Statement', ], 'members' => [ 'Statement' => [ 'shape' => 'Statement', ], ], ], 'OrStatement' => [ 'type' => 'structure', 'required' => [ 'Statements', ], 'members' => [ 'Statements' => [ 'shape' => 'Statements', ], ], ], 'OutputUrl' => [ 'type' => 'string', ], 'OverrideAction' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => 'CountAction', ], 'None' => [ 'shape' => 'NoneAction', ], ], ], 'OversizeHandling' => [ 'type' => 'string', 'enum' => [ 'CONTINUE', 'MATCH', 'NO_MATCH', ], ], 'PaginationLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ParameterExceptionField' => [ 'type' => 'string', 'enum' => [ 'WEB_ACL', 'RULE_GROUP', 'REGEX_PATTERN_SET', 'IP_SET', 'MANAGED_RULE_SET', 'RULE', 'EXCLUDED_RULE', 'STATEMENT', 'BYTE_MATCH_STATEMENT', 'SQLI_MATCH_STATEMENT', 'XSS_MATCH_STATEMENT', 'SIZE_CONSTRAINT_STATEMENT', 'GEO_MATCH_STATEMENT', 'RATE_BASED_STATEMENT', 'RULE_GROUP_REFERENCE_STATEMENT', 'REGEX_PATTERN_REFERENCE_STATEMENT', 'IP_SET_REFERENCE_STATEMENT', 'MANAGED_RULE_SET_STATEMENT', 'LABEL_MATCH_STATEMENT', 'AND_STATEMENT', 'OR_STATEMENT', 'NOT_STATEMENT', 'IP_ADDRESS', 'IP_ADDRESS_VERSION', 'FIELD_TO_MATCH', 'TEXT_TRANSFORMATION', 'SINGLE_QUERY_ARGUMENT', 'SINGLE_HEADER', 'DEFAULT_ACTION', 'RULE_ACTION', 'ENTITY_LIMIT', 'OVERRIDE_ACTION', 'SCOPE_VALUE', 'RESOURCE_ARN', 'RESOURCE_TYPE', 'TAGS', 'TAG_KEYS', 'METRIC_NAME', 'FIREWALL_MANAGER_STATEMENT', 'FALLBACK_BEHAVIOR', 'POSITION', 'FORWARDED_IP_CONFIG', 'IP_SET_FORWARDED_IP_CONFIG', 'HEADER_NAME', 'CUSTOM_REQUEST_HANDLING', 'RESPONSE_CONTENT_TYPE', 'CUSTOM_RESPONSE', 'CUSTOM_RESPONSE_BODY', 'JSON_MATCH_PATTERN', 'JSON_MATCH_SCOPE', 'BODY_PARSING_FALLBACK_BEHAVIOR', 'LOGGING_FILTER', 'FILTER_CONDITION', 'EXPIRE_TIMESTAMP', 'CHANGE_PROPAGATION_STATUS', 'ASSOCIABLE_RESOURCE', 'LOG_DESTINATION', 'MANAGED_RULE_GROUP_CONFIG', 'PAYLOAD_TYPE', 'HEADER_MATCH_PATTERN', 'COOKIE_MATCH_PATTERN', 'MAP_MATCH_SCOPE', 'OVERSIZE_HANDLING', 'CHALLENGE_CONFIG', 'TOKEN_DOMAIN', 'ATP_RULE_SET_RESPONSE_INSPECTION', 'ASSOCIATED_RESOURCE_TYPE', 'SCOPE_DOWN', 'CUSTOM_KEYS', 'ACP_RULE_SET_RESPONSE_INSPECTION', ], ], 'ParameterExceptionParameter' => [ 'type' => 'string', 'min' => 1, ], 'PasswordField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'PayloadType' => [ 'type' => 'string', 'enum' => [ 'JSON', 'FORM_ENCODED', ], ], 'PhoneNumberField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'PhoneNumberFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberField', ], ], 'Platform' => [ 'type' => 'string', 'enum' => [ 'IOS', 'ANDROID', ], ], 'PolicyString' => [ 'type' => 'string', 'max' => 395000, 'min' => 1, 'pattern' => '.*\\S.*', ], 'PopulationSize' => [ 'type' => 'long', ], 'PositionalConstraint' => [ 'type' => 'string', 'enum' => [ 'EXACTLY', 'STARTS_WITH', 'ENDS_WITH', 'CONTAINS', 'CONTAINS_WORD', ], ], 'ProductDescription' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductLink' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ProductTitle' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.*\\S.*', ], 'PublishedVersions' => [ 'type' => 'map', 'key' => [ 'shape' => 'VersionKeyString', ], 'value' => [ 'shape' => 'ManagedRuleSetVersion', ], ], 'PutLoggingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'LoggingConfiguration', ], 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutLoggingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'LoggingConfiguration' => [ 'shape' => 'LoggingConfiguration', ], ], ], 'PutManagedRuleSetVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'RecommendedVersion' => [ 'shape' => 'VersionKeyString', ], 'VersionsToPublish' => [ 'shape' => 'VersionsToPublish', ], ], ], 'PutManagedRuleSetVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'PutPermissionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Policy', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Policy' => [ 'shape' => 'PolicyString', ], ], ], 'PutPermissionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'QueryString' => [ 'type' => 'structure', 'members' => [], ], 'RateBasedStatement' => [ 'type' => 'structure', 'required' => [ 'Limit', 'AggregateKeyType', ], 'members' => [ 'Limit' => [ 'shape' => 'RateLimit', ], 'EvaluationWindowSec' => [ 'shape' => 'EvaluationWindowSec', ], 'AggregateKeyType' => [ 'shape' => 'RateBasedStatementAggregateKeyType', ], 'ScopeDownStatement' => [ 'shape' => 'Statement', ], 'ForwardedIPConfig' => [ 'shape' => 'ForwardedIPConfig', ], 'CustomKeys' => [ 'shape' => 'RateBasedStatementCustomKeys', ], ], ], 'RateBasedStatementAggregateKeyType' => [ 'type' => 'string', 'enum' => [ 'IP', 'FORWARDED_IP', 'CUSTOM_KEYS', 'CONSTANT', ], ], 'RateBasedStatementCustomKey' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'RateLimitHeader', ], 'Cookie' => [ 'shape' => 'RateLimitCookie', ], 'QueryArgument' => [ 'shape' => 'RateLimitQueryArgument', ], 'QueryString' => [ 'shape' => 'RateLimitQueryString', ], 'HTTPMethod' => [ 'shape' => 'RateLimitHTTPMethod', ], 'ForwardedIP' => [ 'shape' => 'RateLimitForwardedIP', ], 'IP' => [ 'shape' => 'RateLimitIP', ], 'LabelNamespace' => [ 'shape' => 'RateLimitLabelNamespace', ], 'UriPath' => [ 'shape' => 'RateLimitUriPath', ], ], ], 'RateBasedStatementCustomKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'RateBasedStatementCustomKey', ], 'max' => 5, ], 'RateBasedStatementManagedKeysIPSet' => [ 'type' => 'structure', 'members' => [ 'IPAddressVersion' => [ 'shape' => 'IPAddressVersion', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], ], ], 'RateLimit' => [ 'type' => 'long', 'max' => 2000000000, 'min' => 10, ], 'RateLimitCookie' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitForwardedIP' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitHTTPMethod' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitIP' => [ 'type' => 'structure', 'members' => [], ], 'RateLimitLabelNamespace' => [ 'type' => 'structure', 'required' => [ 'Namespace', ], 'members' => [ 'Namespace' => [ 'shape' => 'LabelNamespace', ], ], ], 'RateLimitQueryArgument' => [ 'type' => 'structure', 'required' => [ 'Name', 'TextTransformations', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitQueryString' => [ 'type' => 'structure', 'required' => [ 'TextTransformations', ], 'members' => [ 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RateLimitUriPath' => [ 'type' => 'structure', 'required' => [ 'TextTransformations', ], 'members' => [ 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RedactedFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldToMatch', ], 'max' => 100, ], 'Regex' => [ 'type' => 'structure', 'members' => [ 'RegexString' => [ 'shape' => 'RegexPatternString', ], ], ], 'RegexMatchStatement' => [ 'type' => 'structure', 'required' => [ 'RegexString', 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'RegexString' => [ 'shape' => 'RegexPatternString', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RegexPatternSet' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], ], ], 'RegexPatternSetReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'RegexPatternSetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegexPatternSetSummary', ], ], 'RegexPatternSetSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'RegexPatternString' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'RegistrationPagePathString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*\\S.*', ], 'RegularExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Regex', ], ], 'ReleaseNotes' => [ 'type' => 'string', ], 'ReleaseSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReleaseSummary', ], ], 'ReleaseSummary' => [ 'type' => 'structure', 'members' => [ 'ReleaseVersion' => [ 'shape' => 'VersionKeyString', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'RequestBody' => [ 'type' => 'map', 'key' => [ 'shape' => 'AssociatedResourceType', ], 'value' => [ 'shape' => 'RequestBodyAssociatedResourceTypeConfig', ], ], 'RequestBodyAssociatedResourceTypeConfig' => [ 'type' => 'structure', 'required' => [ 'DefaultSizeInspectionLimit', ], 'members' => [ 'DefaultSizeInspectionLimit' => [ 'shape' => 'SizeInspectionLimit', ], ], ], 'RequestInspection' => [ 'type' => 'structure', 'required' => [ 'PayloadType', 'UsernameField', 'PasswordField', ], 'members' => [ 'PayloadType' => [ 'shape' => 'PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', ], ], ], 'RequestInspectionACFP' => [ 'type' => 'structure', 'required' => [ 'PayloadType', ], 'members' => [ 'PayloadType' => [ 'shape' => 'PayloadType', ], 'UsernameField' => [ 'shape' => 'UsernameField', ], 'PasswordField' => [ 'shape' => 'PasswordField', ], 'EmailField' => [ 'shape' => 'EmailField', ], 'PhoneNumberFields' => [ 'shape' => 'PhoneNumberFields', ], 'AddressFields' => [ 'shape' => 'AddressFields', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*\\S.*', ], 'ResourceArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'APPLICATION_LOAD_BALANCER', 'API_GATEWAY', 'APPSYNC', 'COGNITO_USER_POOL', 'APP_RUNNER_SERVICE', 'VERIFIED_ACCESS_INSTANCE', ], ], 'ResponseCode' => [ 'type' => 'integer', ], 'ResponseContent' => [ 'type' => 'string', 'max' => 10240, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'ResponseContentType' => [ 'type' => 'string', 'enum' => [ 'TEXT_PLAIN', 'TEXT_HTML', 'APPLICATION_JSON', ], ], 'ResponseInspection' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'ResponseInspectionStatusCode', ], 'Header' => [ 'shape' => 'ResponseInspectionHeader', ], 'BodyContains' => [ 'shape' => 'ResponseInspectionBodyContains', ], 'Json' => [ 'shape' => 'ResponseInspectionJson', ], ], ], 'ResponseInspectionBodyContains' => [ 'type' => 'structure', 'required' => [ 'SuccessStrings', 'FailureStrings', ], 'members' => [ 'SuccessStrings' => [ 'shape' => 'ResponseInspectionBodyContainsSuccessStrings', ], 'FailureStrings' => [ 'shape' => 'ResponseInspectionBodyContainsFailureStrings', ], ], ], 'ResponseInspectionBodyContainsFailureStrings' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionBodyContainsSuccessStrings' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionHeader' => [ 'type' => 'structure', 'required' => [ 'Name', 'SuccessValues', 'FailureValues', ], 'members' => [ 'Name' => [ 'shape' => 'ResponseInspectionHeaderName', ], 'SuccessValues' => [ 'shape' => 'ResponseInspectionHeaderSuccessValues', ], 'FailureValues' => [ 'shape' => 'ResponseInspectionHeaderFailureValues', ], ], ], 'ResponseInspectionHeaderFailureValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 3, 'min' => 1, ], 'ResponseInspectionHeaderName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ResponseInspectionHeaderSuccessValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 3, 'min' => 1, ], 'ResponseInspectionJson' => [ 'type' => 'structure', 'required' => [ 'Identifier', 'SuccessValues', 'FailureValues', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], 'SuccessValues' => [ 'shape' => 'ResponseInspectionJsonSuccessValues', ], 'FailureValues' => [ 'shape' => 'ResponseInspectionJsonFailureValues', ], ], ], 'ResponseInspectionJsonFailureValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionJsonSuccessValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessValue', ], 'max' => 5, 'min' => 1, ], 'ResponseInspectionStatusCode' => [ 'type' => 'structure', 'required' => [ 'SuccessCodes', 'FailureCodes', ], 'members' => [ 'SuccessCodes' => [ 'shape' => 'ResponseInspectionStatusCodeSuccessCodes', ], 'FailureCodes' => [ 'shape' => 'ResponseInspectionStatusCodeFailureCodes', ], ], ], 'ResponseInspectionStatusCodeFailureCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailureCode', ], 'max' => 10, 'min' => 1, ], 'ResponseInspectionStatusCodeSuccessCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessCode', ], 'max' => 10, 'min' => 1, ], 'ResponseStatusCode' => [ 'type' => 'integer', 'max' => 599, 'min' => 200, ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Name', 'Priority', 'Statement', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Priority' => [ 'shape' => 'RulePriority', ], 'Statement' => [ 'shape' => 'Statement', ], 'Action' => [ 'shape' => 'RuleAction', ], 'OverrideAction' => [ 'shape' => 'OverrideAction', ], 'RuleLabels' => [ 'shape' => 'Labels', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], ], ], 'RuleAction' => [ 'type' => 'structure', 'members' => [ 'Block' => [ 'shape' => 'BlockAction', ], 'Allow' => [ 'shape' => 'AllowAction', ], 'Count' => [ 'shape' => 'CountAction', ], 'Captcha' => [ 'shape' => 'CaptchaAction', ], 'Challenge' => [ 'shape' => 'ChallengeAction', ], ], ], 'RuleActionOverride' => [ 'type' => 'structure', 'required' => [ 'Name', 'ActionToUse', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'ActionToUse' => [ 'shape' => 'RuleAction', ], ], ], 'RuleActionOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleActionOverride', ], 'max' => 100, ], 'RuleGroup' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Capacity', 'ARN', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Capacity' => [ 'shape' => 'CapacityUnit', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'AvailableLabels' => [ 'shape' => 'LabelSummaries', ], 'ConsumedLabels' => [ 'shape' => 'LabelSummaries', ], ], ], 'RuleGroupReferenceStatement' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ResourceArn', ], 'ExcludedRules' => [ 'shape' => 'ExcludedRules', ], 'RuleActionOverrides' => [ 'shape' => 'RuleActionOverrides', ], ], ], 'RuleGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleGroupSummary', ], ], 'RuleGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'RulePriority' => [ 'type' => 'integer', 'min' => 0, ], 'RuleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleSummary', ], ], 'RuleSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Action' => [ 'shape' => 'RuleAction', ], ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], ], 'SampleWeight' => [ 'type' => 'long', 'min' => 0, ], 'SampledHTTPRequest' => [ 'type' => 'structure', 'required' => [ 'Request', 'Weight', ], 'members' => [ 'Request' => [ 'shape' => 'HTTPRequest', ], 'Weight' => [ 'shape' => 'SampleWeight', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], 'Action' => [ 'shape' => 'Action', ], 'RuleNameWithinRuleGroup' => [ 'shape' => 'EntityName', ], 'RequestHeadersInserted' => [ 'shape' => 'HTTPHeaders', ], 'ResponseCodeSent' => [ 'shape' => 'ResponseStatusCode', ], 'Labels' => [ 'shape' => 'Labels', ], 'CaptchaResponse' => [ 'shape' => 'CaptchaResponse', ], 'ChallengeResponse' => [ 'shape' => 'ChallengeResponse', ], 'OverriddenAction' => [ 'shape' => 'Action', ], ], ], 'SampledHTTPRequests' => [ 'type' => 'list', 'member' => [ 'shape' => 'SampledHTTPRequest', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'CLOUDFRONT', 'REGIONAL', ], ], 'SearchString' => [ 'type' => 'blob', ], 'SensitivityLevel' => [ 'type' => 'string', 'enum' => [ 'LOW', 'HIGH', ], ], 'SingleCookieName' => [ 'type' => 'string', 'max' => 60, 'min' => 1, 'pattern' => '.*\\S.*', ], 'SingleHeader' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], ], ], 'SingleQueryArgument' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'FieldToMatchData', ], ], ], 'Size' => [ 'type' => 'long', 'max' => 21474836480, 'min' => 0, ], 'SizeConstraintStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'ComparisonOperator', 'Size', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'Size' => [ 'shape' => 'Size', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], 'SizeInspectionLimit' => [ 'type' => 'string', 'enum' => [ 'KB_16', 'KB_32', 'KB_48', 'KB_64', ], ], 'SolveTimestamp' => [ 'type' => 'long', ], 'SourceType' => [ 'type' => 'string', ], 'SqliMatchStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], 'SensitivityLevel' => [ 'shape' => 'SensitivityLevel', ], ], ], 'Statement' => [ 'type' => 'structure', 'members' => [ 'ByteMatchStatement' => [ 'shape' => 'ByteMatchStatement', ], 'SqliMatchStatement' => [ 'shape' => 'SqliMatchStatement', ], 'XssMatchStatement' => [ 'shape' => 'XssMatchStatement', ], 'SizeConstraintStatement' => [ 'shape' => 'SizeConstraintStatement', ], 'GeoMatchStatement' => [ 'shape' => 'GeoMatchStatement', ], 'RuleGroupReferenceStatement' => [ 'shape' => 'RuleGroupReferenceStatement', ], 'IPSetReferenceStatement' => [ 'shape' => 'IPSetReferenceStatement', ], 'RegexPatternSetReferenceStatement' => [ 'shape' => 'RegexPatternSetReferenceStatement', ], 'RateBasedStatement' => [ 'shape' => 'RateBasedStatement', ], 'AndStatement' => [ 'shape' => 'AndStatement', ], 'OrStatement' => [ 'shape' => 'OrStatement', ], 'NotStatement' => [ 'shape' => 'NotStatement', ], 'ManagedRuleGroupStatement' => [ 'shape' => 'ManagedRuleGroupStatement', ], 'LabelMatchStatement' => [ 'shape' => 'LabelMatchStatement', ], 'RegexMatchStatement' => [ 'shape' => 'RegexMatchStatement', ], ], ], 'Statements' => [ 'type' => 'list', 'member' => [ 'shape' => 'Statement', ], ], 'String' => [ 'type' => 'string', ], 'SuccessCode' => [ 'type' => 'integer', 'max' => 999, 'min' => 0, ], 'SuccessValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '.*\\S.*', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagInfoForResource' => [ 'type' => 'structure', 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TextTransformation' => [ 'type' => 'structure', 'required' => [ 'Priority', 'Type', ], 'members' => [ 'Priority' => [ 'shape' => 'TextTransformationPriority', ], 'Type' => [ 'shape' => 'TextTransformationType', ], ], ], 'TextTransformationPriority' => [ 'type' => 'integer', 'min' => 0, ], 'TextTransformationType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'COMPRESS_WHITE_SPACE', 'HTML_ENTITY_DECODE', 'LOWERCASE', 'CMD_LINE', 'URL_DECODE', 'BASE64_DECODE', 'HEX_DECODE', 'MD5', 'REPLACE_COMMENTS', 'ESCAPE_SEQ_DECODE', 'SQL_HEX_DECODE', 'CSS_DECODE', 'JS_DECODE', 'NORMALIZE_PATH', 'NORMALIZE_PATH_WIN', 'REMOVE_NULLS', 'REPLACE_NULLS', 'BASE64_DECODE_EXT', 'URL_DECODE_UNI', 'UTF8_TO_UNICODE', ], ], 'TextTransformations' => [ 'type' => 'list', 'member' => [ 'shape' => 'TextTransformation', ], 'min' => 1, ], 'TimeWindow' => [ 'type' => 'structure', 'required' => [ 'StartTime', 'EndTime', ], 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'TimeWindowDay' => [ 'type' => 'integer', 'min' => 1, ], 'TimeWindowSecond' => [ 'type' => 'long', 'max' => 259200, 'min' => 60, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TokenDomain' => [ 'type' => 'string', 'max' => 253, 'min' => 1, 'pattern' => '^[\\w\\.\\-/]+$', ], 'TokenDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'TokenDomain', ], ], 'URIString' => [ 'type' => 'string', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateIPSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'Addresses', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Addresses' => [ 'shape' => 'IPAddresses', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateIPSetResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateManagedRuleSetVersionExpiryDateRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'LockToken', 'VersionToExpire', 'ExpiryTimestamp', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'VersionToExpire' => [ 'shape' => 'VersionKeyString', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateManagedRuleSetVersionExpiryDateResponse' => [ 'type' => 'structure', 'members' => [ 'ExpiringVersion' => [ 'shape' => 'VersionKeyString', ], 'ExpiryTimestamp' => [ 'shape' => 'Timestamp', ], 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRegexPatternSetRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'RegularExpressionList', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'RegularExpressionList' => [ 'shape' => 'RegularExpressionList', ], 'LockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRegexPatternSetResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateRuleGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'VisibilityConfig', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], ], ], 'UpdateRuleGroupResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UpdateWebACLRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Scope', 'Id', 'DefaultAction', 'VisibilityConfig', 'LockToken', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Scope' => [ 'shape' => 'Scope', ], 'Id' => [ 'shape' => 'EntityId', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'UpdateWebACLResponse' => [ 'type' => 'structure', 'members' => [ 'NextLockToken' => [ 'shape' => 'LockToken', ], ], ], 'UriPath' => [ 'type' => 'structure', 'members' => [], ], 'UsernameField' => [ 'type' => 'structure', 'required' => [ 'Identifier', ], 'members' => [ 'Identifier' => [ 'shape' => 'FieldIdentifier', ], ], ], 'VendorName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'VersionKeyString' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[\\w#:\\.\\-/]+$', ], 'VersionToPublish' => [ 'type' => 'structure', 'members' => [ 'AssociatedRuleGroupArn' => [ 'shape' => 'ResourceArn', ], 'ForecastedLifetime' => [ 'shape' => 'TimeWindowDay', ], ], ], 'VersionsToPublish' => [ 'type' => 'map', 'key' => [ 'shape' => 'VersionKeyString', ], 'value' => [ 'shape' => 'VersionToPublish', ], ], 'VisibilityConfig' => [ 'type' => 'structure', 'required' => [ 'SampledRequestsEnabled', 'CloudWatchMetricsEnabled', 'MetricName', ], 'members' => [ 'SampledRequestsEnabled' => [ 'shape' => 'Boolean', ], 'CloudWatchMetricsEnabled' => [ 'shape' => 'Boolean', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'WAFAssociatedItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFConfigurationWarningException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFDuplicateItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFExpiredManagedRuleGroupVersionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'WAFInvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], 'Field' => [ 'shape' => 'ParameterExceptionField', ], 'Parameter' => [ 'shape' => 'ParameterExceptionParameter', ], 'Reason' => [ 'shape' => 'ErrorReason', ], ], 'exception' => true, ], 'WAFInvalidPermissionPolicyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFInvalidResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFLimitsExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], 'exception' => true, ], 'WAFLogDestinationPermissionIssueException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFNonexistentItemException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFOptimisticLockException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFServiceLinkedRoleErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFSubscriptionNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFTagOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFTagOperationInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'WAFUnavailableEntityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WAFUnsupportedAggregateKeyTypeException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'WebACL' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'ARN', 'DefaultAction', 'VisibilityConfig', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'ARN' => [ 'shape' => 'ResourceArn', ], 'DefaultAction' => [ 'shape' => 'DefaultAction', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Rules' => [ 'shape' => 'Rules', ], 'VisibilityConfig' => [ 'shape' => 'VisibilityConfig', ], 'Capacity' => [ 'shape' => 'ConsumedCapacity', ], 'PreProcessFirewallManagerRuleGroups' => [ 'shape' => 'FirewallManagerRuleGroups', ], 'PostProcessFirewallManagerRuleGroups' => [ 'shape' => 'FirewallManagerRuleGroups', ], 'ManagedByFirewallManager' => [ 'shape' => 'Boolean', ], 'LabelNamespace' => [ 'shape' => 'LabelName', ], 'CustomResponseBodies' => [ 'shape' => 'CustomResponseBodies', ], 'CaptchaConfig' => [ 'shape' => 'CaptchaConfig', ], 'ChallengeConfig' => [ 'shape' => 'ChallengeConfig', ], 'TokenDomains' => [ 'shape' => 'TokenDomains', ], 'AssociationConfig' => [ 'shape' => 'AssociationConfig', ], ], ], 'WebACLSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'WebACLSummary', ], ], 'WebACLSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Id' => [ 'shape' => 'EntityId', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'LockToken' => [ 'shape' => 'LockToken', ], 'ARN' => [ 'shape' => 'ResourceArn', ], ], ], 'XssMatchStatement' => [ 'type' => 'structure', 'required' => [ 'FieldToMatch', 'TextTransformations', ], 'members' => [ 'FieldToMatch' => [ 'shape' => 'FieldToMatch', ], 'TextTransformations' => [ 'shape' => 'TextTransformations', ], ], ], ],]; diff --git a/src/data/wafv2/2019-07-29/docs-2.json b/src/data/wafv2/2019-07-29/docs-2.json index 2693ff744b..4a282655ca 100644 --- a/src/data/wafv2/2019-07-29/docs-2.json +++ b/src/data/wafv2/2019-07-29/docs-2.json @@ -48,7 +48,7 @@ "ListWebACLs": "

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

", "PutLoggingConfiguration": "

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

To modify an existing logging configuration, do the following:

  1. Retrieve it by calling GetLoggingConfiguration

  2. Update its settings as needed

  3. Provide the complete logging configuration specification to this call

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

", "PutManagedRuleSetVersions": "

Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

", - "PutPermissionPolicy": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

", + "PutPermissionPolicy": "

Use this to share a rule group with other accounts.

This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don't appear in your WAF console rule groups listing.

", "TagResource": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

", "UntagResource": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

", "UpdateIPSet": "

Updates the specified IPSet.

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

To modify an IP set, do the following:

  1. Retrieve it by calling GetIPSet

  2. Update its settings as needed

  3. Provide the complete IP set specification to this call

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

", diff --git a/src/data/wafv2/2019-07-29/docs-2.json.php b/src/data/wafv2/2019-07-29/docs-2.json.php index a2609225c1..657e8bd3b4 100644 --- a/src/data/wafv2/2019-07-29/docs-2.json.php +++ b/src/data/wafv2/2019-07-29/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'WAF

This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

If you used WAF prior to this release, you can\'t use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.

For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.

This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the WAF Developer Guide.

You can make calls using the endpoints listed in WAF endpoints and quotas.

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that\'s tailored to the programming language or platform that you\'re using. For more information, see Amazon Web Services SDKs.

We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:

', 'operations' => [ 'AssociateWebACL' => '

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

For Amazon CloudFront, don\'t use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'CheckCapacity' => '

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'CreateAPIKey' => '

Creates an API key that contains a set of token domains.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

', 'CreateIPSet' => '

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you\'re receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

', 'CreateRegexPatternSet' => '

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

', 'CreateRuleGroup' => '

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

', 'CreateWebACL' => '

Creates a WebACL per the specifications provided.

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

', 'DeleteAPIKey' => '

Deletes the specified API key.

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

', 'DeleteFirewallManagerRuleGroups' => '

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

', 'DeleteIPSet' => '

Deletes the specified IPSet.

', 'DeleteLoggingConfiguration' => '

Deletes the LoggingConfiguration from the specified web ACL.

', 'DeletePermissionPolicy' => '

Permanently deletes an IAM policy from the specified rule group.

You must be the owner of the rule group to perform this operation.

', 'DeleteRegexPatternSet' => '

Deletes the specified RegexPatternSet.

', 'DeleteRuleGroup' => '

Deletes the specified RuleGroup.

', 'DeleteWebACL' => '

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

Before deleting any web ACL, first disassociate it from all resources.

', 'DescribeAllManagedProducts' => '

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

', 'DescribeManagedProductsByVendor' => '

Provides high-level information for the managed rule groups owned by a specific vendor.

', 'DescribeManagedRuleGroup' => '

Provides high-level information for a managed rule group, including descriptions of the rules.

', 'DisassociateWebACL' => '

Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

For Amazon CloudFront, don\'t use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.

', 'GenerateMobileSdkReleaseUrl' => '

Generates a presigned download URL for the specified release of the mobile SDK.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'GetDecryptedAPIKey' => '

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'GetIPSet' => '

Retrieves the specified IPSet.

', 'GetLoggingConfiguration' => '

Returns the LoggingConfiguration for the specified web ACL.

', 'GetManagedRuleSet' => '

Retrieves the specified managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'GetMobileSdkRelease' => '

Retrieves information for the specified mobile SDK release, including release notes and tags.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'GetPermissionPolicy' => '

Returns the IAM policy that is attached to the specified rule group.

You must be the owner of the rule group to perform this operation.

', 'GetRateBasedStatementManagedKeys' => '

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.

The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

For a rate-based rule that you\'ve defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.

', 'GetRegexPatternSet' => '

Retrieves the specified RegexPatternSet.

', 'GetRuleGroup' => '

Retrieves the specified RuleGroup.

', 'GetSampledRequests' => '

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

', 'GetWebACL' => '

Retrieves the specified WebACL.

', 'GetWebACLForResource' => '

Retrieves the WebACL for the specified resource.

This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn\'t authorized to perform wafv2:GetWebACL on the resource, that error won\'t be included in your CloudTrail event history.

For Amazon CloudFront, don\'t use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.

', 'ListAPIKeys' => '

Retrieves a list of the API keys that you\'ve defined for the specified scope.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'ListAvailableManagedRuleGroupVersions' => '

Returns a list of the available versions for the specified managed rule group.

', 'ListAvailableManagedRuleGroups' => '

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you\'re subscribed to.

', 'ListIPSets' => '

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

', 'ListLoggingConfigurations' => '

Retrieves an array of your LoggingConfiguration objects.

', 'ListManagedRuleSets' => '

Retrieves the managed rule sets that you own.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'ListMobileSdkReleases' => '

Retrieves a list of the available releases for the mobile SDK and the specified device platform.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'ListRegexPatternSets' => '

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

', 'ListResourcesForWebACL' => '

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

For Amazon CloudFront, don\'t use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.

', 'ListRuleGroups' => '

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

', 'ListTagsForResource' => '

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'ListWebACLs' => '

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

', 'PutLoggingConfiguration' => '

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

To modify an existing logging configuration, do the following:

  1. Retrieve it by calling GetLoggingConfiguration

  2. Update its settings as needed

  3. Provide the complete logging configuration specification to this call

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

', 'PutManagedRuleSetVersions' => '

Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

', 'PutPermissionPolicy' => '

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

', 'TagResource' => '

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'UntagResource' => '

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

', 'UpdateIPSet' => '

Updates the specified IPSet.

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

To modify an IP set, do the following:

  1. Retrieve it by calling GetIPSet

  2. Update its settings as needed

  3. Provide the complete IP set specification to this call

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateManagedRuleSetVersionExpiryDate' => '

Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'UpdateRegexPatternSet' => '

Updates the specified RegexPatternSet.

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

To modify a regex pattern set, do the following:

  1. Retrieve it by calling GetRegexPatternSet

  2. Update its settings as needed

  3. Provide the complete regex pattern set specification to this call

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateRuleGroup' => '

Updates the specified RuleGroup.

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

To modify a rule group, do the following:

  1. Retrieve it by calling GetRuleGroup

  2. Update its settings as needed

  3. Provide the complete rule group specification to this call

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateWebACL' => '

Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

To modify a web ACL, do the following:

  1. Retrieve it by calling GetWebACL

  2. Update its settings as needed

  3. Provide the complete web ACL specification to this call

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', ], 'shapes' => [ 'APIKey' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$APIKey' => '

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

', 'CreateAPIKeyResponse$APIKey' => '

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

', 'DeleteAPIKeyRequest$APIKey' => '

The encrypted API key that you want to delete.

', 'GetDecryptedAPIKeyRequest$APIKey' => '

The encrypted API key.

', ], ], 'APIKeySummaries' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysResponse$APIKeySummaries' => '

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

', ], ], 'APIKeySummary' => [ 'base' => '

Information for a single API key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'refs' => [ 'APIKeySummaries$member' => NULL, ], ], 'APIKeyTokenDomains' => [ 'base' => NULL, 'refs' => [ 'CreateAPIKeyRequest$TokenDomains' => '

The client application domains that you want to use this API key for.

Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', ], ], 'APIKeyVersion' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$Version' => '

Internal value used by WAF to manage the key.

', ], ], 'AWSManagedRulesACFPRuleSet' => [ 'base' => '

Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesACFPRuleSet' => '

Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.

For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.

', ], ], 'AWSManagedRulesATPRuleSet' => [ 'base' => '

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesATPRuleSet' => '

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

', ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'base' => '

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesBotControlRuleSet' => '

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'SampledHTTPRequest$Action' => '

The action that WAF applied to the request.

', 'SampledHTTPRequest$OverriddenAction' => '

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

', ], ], 'ActionCondition' => [ 'base' => '

A single action condition for a Condition in a logging filter.

', 'refs' => [ 'Condition$ActionCondition' => '

A single action condition. This is the action setting that a log record must contain in order to meet the condition.

', ], ], 'ActionValue' => [ 'base' => NULL, 'refs' => [ 'ActionCondition$Action' => '

The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

For rule groups, this is either the configured rule action setting, or if you\'ve applied a rule action override to the rule, it\'s the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a rule action override of Count.

', ], ], 'AddressField' => [ 'base' => '

The name of a field in the request payload that contains part or all of your customer\'s primary physical address.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'AddressFields$member' => NULL, ], ], 'AddressFields' => [ 'base' => NULL, 'refs' => [ 'RequestInspectionACFP$AddressFields' => '

The names of the fields in the request payload that contain your customer\'s primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

', ], ], 'All' => [ 'base' => '

Inspect all of the elements that WAF has parsed and extracted from the web request component that you\'ve identified in your FieldToMatch specifications.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "All": {}

', 'refs' => [ 'CookieMatchPattern$All' => '

Inspect all cookies.

', 'HeaderMatchPattern$All' => '

Inspect all headers.

', 'JsonMatchPattern$All' => '

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

', ], ], 'AllQueryArguments' => [ 'base' => '

Inspect all query arguments of the web request.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "AllQueryArguments": {}

', 'refs' => [ 'FieldToMatch$AllQueryArguments' => '

Inspect all query arguments.

', ], ], 'AllowAction' => [ 'base' => '

Specifies that WAF should allow the request and optionally defines additional custom handling for the request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'DefaultAction$Allow' => '

Specifies that WAF should allow requests by default.

', 'RuleAction$Allow' => '

Instructs WAF to allow the web request.

', ], ], 'AndStatement' => [ 'base' => '

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

', 'refs' => [ 'Statement$AndStatement' => '

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

', ], ], 'AssociateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'RequestBody$key' => NULL, ], ], 'AssociationConfig' => [ 'base' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'refs' => [ 'CreateWebACLRequest$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'UpdateWebACLRequest$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'WebACL$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', ], ], 'BlockAction' => [ 'base' => '

Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'DefaultAction$Block' => '

Specifies that WAF should block requests by default.

', 'RuleAction$Block' => '

Instructs WAF to block the web request.

', ], ], 'Body' => [ 'base' => '

Inspect the body of the web request. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

', 'refs' => [ 'FieldToMatch$Body' => '

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

For information about how to handle oversized request bodies, see the Body object configuration.

', ], ], 'BodyParsingFallbackBehavior' => [ 'base' => NULL, 'refs' => [ 'JsonBody$InvalidFallbackBehavior' => '

What WAF should do if it fails to completely parse the JSON body. The options are the following:

If you don\'t provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF parsing doesn\'t fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn\'t apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$EnableRegexInPath' => '

Allow the use of regular expressions in the registration page path and the account creation path.

', 'AWSManagedRulesATPRuleSet$EnableRegexInPath' => '

Allow the use of regular expressions in the login page path.

', 'LoggingConfiguration$ManagedByFirewallManager' => '

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

', 'ManagedProductDescriptor$IsVersioningSupported' => '

Indicates whether the rule group is versioned.

', 'ManagedProductDescriptor$IsAdvancedManagedRuleSet' => '

Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.

', 'ManagedRuleGroupSummary$VersioningSupported' => '

Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.

', 'VisibilityConfig$SampledRequestsEnabled' => '

Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

Request sampling doesn\'t provide a field redaction option, and any field redaction that you specify in your logging configuration doesn\'t affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

', 'VisibilityConfig$CloudWatchMetricsEnabled' => '

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.

', 'WebACL$ManagedByFirewallManager' => '

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

', ], ], 'ByteMatchStatement' => [ 'base' => '

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

', 'refs' => [ 'Statement$ByteMatchStatement' => '

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

', ], ], 'CapacityUnit' => [ 'base' => NULL, 'refs' => [ 'CreateRuleGroupRequest$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'DescribeManagedRuleGroupResponse$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'ManagedRuleSetVersion$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'RuleGroup$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', ], ], 'CaptchaAction' => [ 'base' => '

Specifies that WAF should run a CAPTCHA check against the request:

You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn\'t available for web ACL default actions.

', 'refs' => [ 'RuleAction$Captcha' => '

Instructs WAF to run a CAPTCHA check against the web request.

', ], ], 'CaptchaConfig' => [ 'base' => '

Specifies how WAF should handle CAPTCHA evaluations. This is available at the web ACL level and in each rule.

', 'refs' => [ 'CreateWebACLRequest$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', 'Rule$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations. If you don\'t specify this, WAF uses the CAPTCHA configuration that\'s defined for the web ACL.

', 'UpdateWebACLRequest$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', 'WebACL$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', ], ], 'CaptchaResponse' => [ 'base' => '

The result from the inspection of the web request for a valid CAPTCHA token.

', 'refs' => [ 'SampledHTTPRequest$CaptchaResponse' => '

The CAPTCHA response for the request.

', ], ], 'ChallengeAction' => [ 'base' => '

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn\'t available for web ACL default actions.

', 'refs' => [ 'RuleAction$Challenge' => '

Instructs WAF to run a Challenge check against the web request.

', ], ], 'ChallengeConfig' => [ 'base' => '

Specifies how WAF should handle Challenge evaluations. This is available at the web ACL level and in each rule.

', 'refs' => [ 'CreateWebACLRequest$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', 'Rule$ChallengeConfig' => '

Specifies how WAF should handle Challenge evaluations. If you don\'t specify this, WAF uses the challenge configuration that\'s defined for the web ACL.

', 'UpdateWebACLRequest$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', 'WebACL$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', ], ], 'ChallengeResponse' => [ 'base' => '

The result from the inspection of the web request for a valid challenge token.

', 'refs' => [ 'SampledHTTPRequest$ChallengeResponse' => '

The Challenge response for the request.

', ], ], 'CheckCapacityRequest' => [ 'base' => NULL, 'refs' => [], ], 'CheckCapacityResponse' => [ 'base' => NULL, 'refs' => [], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'SizeConstraintStatement$ComparisonOperator' => '

The operator to use to compare the request part to the size setting.

', ], ], 'Condition' => [ 'base' => '

A single match condition for a Filter.

', 'refs' => [ 'Conditions$member' => NULL, ], ], 'Conditions' => [ 'base' => NULL, 'refs' => [ 'Filter$Conditions' => '

Match conditions for the filter.

', ], ], 'ConsumedCapacity' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityResponse$Capacity' => '

The capacity required by the rules and scope.

', 'WebACL$Capacity' => '

The web ACL capacity units (WCUs) currently being used by this web ACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', ], ], 'CookieMatchPattern' => [ 'base' => '

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

', 'refs' => [ 'Cookies$MatchPattern' => '

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

', ], ], 'CookieNames' => [ 'base' => NULL, 'refs' => [ 'CookieMatchPattern$IncludedCookies' => '

Inspect only the cookies that have a key that matches one of the strings specified here.

', 'CookieMatchPattern$ExcludedCookies' => '

Inspect only the cookies whose keys don\'t match any of the strings specified here.

', ], ], 'Cookies' => [ 'base' => '

Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

', 'refs' => [ 'FieldToMatch$Cookies' => '

Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

Only the first 8 KB (8192 bytes) of a request\'s cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

', ], ], 'CountAction' => [ 'base' => '

Specifies that WAF should count the request. Optionally defines additional custom handling for the request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'OverrideAction$Count' => '

Override the rule group evaluation result to count only.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'RuleAction$Count' => '

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

', ], ], 'Country' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Country' => '

The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'CountryCodes$member' => NULL, ], ], 'CountryCodes' => [ 'base' => NULL, 'refs' => [ 'GeoMatchStatement$CountryCodes' => '

An array of two-character country codes that you want to match against, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that\'s unlikely to be a source of traffic to your site.

', ], ], 'CreateAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationPathString' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$CreationPath' => '

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

For example, for the URL https://example.com/web/newaccount, you would provide the path /web/newaccount. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount matches the account creation paths /web/newaccount, /web/newaccount/, /web/newaccountPage, and /web/newaccount/thisPage, but doesn\'t match the path /home/web/newaccount or /website/newaccount.

', ], ], 'CustomHTTPHeader' => [ 'base' => '

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

', 'refs' => [ 'CustomHTTPHeaders$member' => NULL, ], ], 'CustomHTTPHeaderName' => [ 'base' => NULL, 'refs' => [ 'CustomHTTPHeader$Name' => '

The name of the custom header.

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

', ], ], 'CustomHTTPHeaderValue' => [ 'base' => NULL, 'refs' => [ 'CustomHTTPHeader$Value' => '

The value of the custom header.

', ], ], 'CustomHTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'CustomRequestHandling$InsertHeaders' => '

The HTTP headers to insert into the request. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'CustomResponse$ResponseHeaders' => '

The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'CustomRequestHandling' => [ 'base' => '

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for WAF to use when the rule action doesn\'t block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'refs' => [ 'AllowAction$CustomRequestHandling' => '

Defines custom handling for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'CaptchaAction$CustomRequestHandling' => '

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request\'s token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'ChallengeAction$CustomRequestHandling' => '

Defines custom handling for the web request, used when the challenge inspection determines that the request\'s token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'CountAction$CustomRequestHandling' => '

Defines custom handling for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', ], ], 'CustomResponse' => [ 'base' => '

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'refs' => [ 'BlockAction$CustomResponse' => '

Defines a custom response for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', ], ], 'CustomResponseBodies' => [ 'base' => NULL, 'refs' => [ 'CreateRuleGroupRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'CreateWebACLRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'RuleGroup$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'UpdateRuleGroupRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'UpdateWebACLRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'WebACL$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'CustomResponseBody' => [ 'base' => '

The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey.

', 'refs' => [ 'CustomResponseBodies$value' => NULL, ], ], 'DefaultAction' => [ 'base' => '

In a WebACL, this is the action that you want WAF to perform when a web request doesn\'t match any of the rules in the WebACL. The default action must be a terminating action.

', 'refs' => [ 'CreateWebACLRequest$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', 'UpdateWebACLRequest$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', 'WebACL$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', ], ], 'DeleteAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallManagerRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallManagerRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAllManagedProductsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAllManagedProductsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedProductsByVendorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedProductsByVendorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'DownloadUrl' => [ 'base' => NULL, 'refs' => [ 'GenerateMobileSdkReleaseUrlResponse$Url' => '

The presigned download URL for the specified SDK release.

', ], ], 'EmailField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s email.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'RequestInspectionACFP$EmailField' => '

The name of the field in the request payload that contains your customer\'s email.

How you specify this depends on the request inspection payload type.

', ], ], 'EnableMachineLearning' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesBotControlRuleSet$EnableMachineLearning' => '

Applies only to the targeted inspection level.

Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.

For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.

Default: TRUE

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Description' => '

A description of the IP set that helps with identification.

', 'CreateRegexPatternSetRequest$Description' => '

A description of the set that helps with identification.

', 'CreateRuleGroupRequest$Description' => '

A description of the rule group that helps with identification.

', 'CreateWebACLRequest$Description' => '

A description of the web ACL that helps with identification.

', 'IPSet$Description' => '

A description of the IP set that helps with identification.

', 'IPSetSummary$Description' => '

A description of the IP set that helps with identification.

', 'ManagedRuleGroupSummary$Description' => '

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.

', 'ManagedRuleSet$Description' => '

A description of the set that helps with identification.

', 'ManagedRuleSetSummary$Description' => '

A description of the set that helps with identification.

', 'RegexPatternSet$Description' => '

A description of the set that helps with identification.

', 'RegexPatternSetSummary$Description' => '

A description of the set that helps with identification.

', 'RuleGroup$Description' => '

A description of the rule group that helps with identification.

', 'RuleGroupSummary$Description' => '

A description of the rule group that helps with identification.

', 'UpdateIPSetRequest$Description' => '

A description of the IP set that helps with identification.

', 'UpdateRegexPatternSetRequest$Description' => '

A description of the set that helps with identification.

', 'UpdateRuleGroupRequest$Description' => '

A description of the rule group that helps with identification.

', 'UpdateWebACLRequest$Description' => '

A description of the web ACL that helps with identification.

', 'WebACL$Description' => '

A description of the web ACL that helps with identification.

', 'WebACLSummary$Description' => '

A description of the web ACL that helps with identification.

', ], ], 'EntityId' => [ 'base' => NULL, 'refs' => [ 'DeleteIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetManagedRuleSetRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'GetRateBasedStatementManagedKeysRequest$WebACLId' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'IPSet$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'IPSetSummary$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'ManagedRuleSet$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'ManagedRuleSetSummary$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'PutManagedRuleSetVersionsRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'RegexPatternSet$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RegexPatternSetSummary$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RuleGroup$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RuleGroupSummary$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'UpdateRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'WebACL$Id' => '

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

', 'WebACLSummary$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'CreateRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'CreateRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'CreateWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'CustomResponse$CustomResponseBodyKey' => '

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

', 'CustomResponseBodies$key' => NULL, 'DeleteIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'DeleteRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'DeleteRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'DeleteWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'DescribeManagedRuleGroupRequest$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ExcludedRule$Name' => '

The name of the rule whose action you want to override to Count.

', 'FirewallManagerRuleGroup$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'GetIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'GetManagedRuleSetRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'GetRateBasedStatementManagedKeysRequest$WebACLName' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'GetRateBasedStatementManagedKeysRequest$RuleGroupRuleName' => '

The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

', 'GetRateBasedStatementManagedKeysRequest$RuleName' => '

The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you\'re using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

', 'GetRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'GetRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'GetWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'IPSet$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'IPSetSummary$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'ListAvailableManagedRuleGroupVersionsRequest$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedProductDescriptor$ManagedRuleSetName' => '

The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

', 'ManagedRuleGroupStatement$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedRuleGroupSummary$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedRuleSet$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'ManagedRuleSetSummary$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'PutManagedRuleSetVersionsRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'RegexPatternSet$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'RegexPatternSetSummary$Name' => '

The name of the data type instance. You cannot change the name after you create the instance.

', 'Rule$Name' => '

The name of the rule.

If you change the name of a Rule after you create it and you want the rule\'s metric name to reflect the change, update the metric name in the rule\'s VisibilityConfig settings. WAF doesn\'t automatically update the metric name when you update the rule name.

', 'RuleActionOverride$Name' => '

The name of the rule to override.

', 'RuleGroup$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'RuleGroupSummary$Name' => '

The name of the data type instance. You cannot change the name after you create the instance.

', 'RuleSummary$Name' => '

The name of the rule.

', 'SampledHTTPRequest$RuleNameWithinRuleGroup' => '

The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.

', 'UpdateIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'UpdateRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'UpdateRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'UpdateWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'WebACL$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'WebACLSummary$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WAFAssociatedItemException$Message' => NULL, 'WAFConfigurationWarningException$Message' => NULL, 'WAFDuplicateItemException$Message' => NULL, 'WAFExpiredManagedRuleGroupVersionException$Message' => NULL, 'WAFInternalErrorException$Message' => NULL, 'WAFInvalidOperationException$Message' => NULL, 'WAFInvalidParameterException$message' => NULL, 'WAFInvalidPermissionPolicyException$Message' => NULL, 'WAFInvalidResourceException$Message' => NULL, 'WAFLimitsExceededException$Message' => NULL, 'WAFLogDestinationPermissionIssueException$Message' => NULL, 'WAFNonexistentItemException$Message' => NULL, 'WAFOptimisticLockException$Message' => NULL, 'WAFServiceLinkedRoleErrorException$message' => NULL, 'WAFSubscriptionNotFoundException$Message' => NULL, 'WAFTagOperationException$Message' => NULL, 'WAFTagOperationInternalErrorException$Message' => NULL, 'WAFUnavailableEntityException$Message' => NULL, 'WAFUnsupportedAggregateKeyTypeException$Message' => NULL, ], ], 'ErrorReason' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Reason' => '

Additional information about the exception.

', ], ], 'EvaluationWindowSec' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$EvaluationWindowSec' => '

The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.

This setting doesn\'t determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.

Default: 300 (5 minutes)

', ], ], 'ExcludedRule' => [ 'base' => '

Specifies a single rule in a rule group whose action you want to override to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', 'refs' => [ 'ExcludedRules$member' => NULL, ], ], 'ExcludedRules' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$ExcludedRules' => '

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', 'RuleGroupReferenceStatement$ExcludedRules' => '

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', ], ], 'FailureCode' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCodeFailureCodes$member' => NULL, ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$FailureReason' => '

The reason for failure, populated when the evaluation of the token fails.

', 'ChallengeResponse$FailureReason' => '

The reason for failure, populated when the evaluation of the token fails.

', ], ], 'FailureValue' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContainsFailureStrings$member' => NULL, 'ResponseInspectionHeaderFailureValues$member' => NULL, 'ResponseInspectionJsonFailureValues$member' => NULL, ], ], 'FallbackBehavior' => [ 'base' => NULL, 'refs' => [ 'ForwardedIPConfig$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a valid IP address in the specified position.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

You can specify the following fallback behaviors:

', 'IPSetForwardedIPConfig$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a valid IP address in the specified position.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

You can specify the following fallback behaviors:

', 'JA3Fingerprint$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a JA3 fingerprint.

You can specify the following fallback behaviors:

', ], ], 'FieldIdentifier' => [ 'base' => NULL, 'refs' => [ 'AddressField$Identifier' => '

The name of a single primary address field.

How you specify the address fields depends on the request inspection payload type.

', 'EmailField$Identifier' => '

The name of the email field.

How you specify this depends on the request inspection payload type.

', 'PasswordField$Identifier' => '

The name of the password field.

How you specify this depends on the request inspection payload type.

', 'PhoneNumberField$Identifier' => '

The name of a single primary phone number field.

How you specify the phone number fields depends on the request inspection payload type.

', 'ResponseInspectionJson$Identifier' => '

The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/sign-up/success" ]

', 'UsernameField$Identifier' => '

The name of the username field.

How you specify this depends on the request inspection payload type.

', ], ], 'FieldToMatch' => [ 'base' => '

Specifies a web request component to be used in a rule match statement or in a logging configuration.

', 'refs' => [ 'ByteMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'RedactedFields$member' => NULL, 'RegexMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'RegexPatternSetReferenceStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'SizeConstraintStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'SqliMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'XssMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', ], ], 'FieldToMatchData' => [ 'base' => NULL, 'refs' => [ 'HeaderNames$member' => NULL, 'RateLimitCookie$Name' => '

The name of the cookie to use.

', 'RateLimitHeader$Name' => '

The name of the header to use.

', 'RateLimitQueryArgument$Name' => '

The name of the query argument to use.

', 'SingleHeader$Name' => '

The name of the query header to inspect.

', 'SingleQueryArgument$Name' => '

The name of the query argument to inspect.

', ], ], 'Filter' => [ 'base' => '

A single logging filter, used in LoggingFilter.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'FilterBehavior' => [ 'base' => NULL, 'refs' => [ 'Filter$Behavior' => '

How to handle logs that satisfy the filter\'s conditions and requirement.

', 'LoggingFilter$DefaultBehavior' => '

Default handling for logs that don\'t match any of the specified filtering conditions.

', ], ], 'FilterRequirement' => [ 'base' => NULL, 'refs' => [ 'Filter$Requirement' => '

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

', ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'LoggingFilter$Filters' => '

The filters that you want to apply to the logs.

', ], ], 'FirewallManagerRuleGroup' => [ 'base' => '

A rule group that\'s defined for an Firewall Manager WAF policy.

', 'refs' => [ 'FirewallManagerRuleGroups$member' => NULL, ], ], 'FirewallManagerRuleGroups' => [ 'base' => NULL, 'refs' => [ 'WebACL$PreProcessFirewallManagerRuleGroups' => '

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can\'t alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

', 'WebACL$PostProcessFirewallManagerRuleGroups' => '

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can\'t alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

', ], ], 'FirewallManagerStatement' => [ 'base' => '

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.

', 'refs' => [ 'FirewallManagerRuleGroup$FirewallManagerStatement' => '

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

', ], ], 'ForwardedIPConfig' => [ 'base' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

', 'refs' => [ 'GeoMatchStatement$ForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', 'RateBasedStatement$ForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This is required if you specify a forwarded IP in the rule\'s aggregate key settings.

', ], ], 'ForwardedIPHeaderName' => [ 'base' => NULL, 'refs' => [ 'ForwardedIPConfig$HeaderName' => '

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', 'IPSetForwardedIPConfig$HeaderName' => '

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', ], ], 'ForwardedIPPosition' => [ 'base' => NULL, 'refs' => [ 'IPSetForwardedIPConfig$Position' => '

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

', ], ], 'GenerateMobileSdkReleaseUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateMobileSdkReleaseUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GeoMatchStatement' => [ 'base' => '

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.

For additional details, see Geographic match rule statement in the WAF Developer Guide.

', 'refs' => [ 'Statement$GeoMatchStatement' => '

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.

For additional details, see Geographic match rule statement in the WAF Developer Guide.

', ], ], 'GetDecryptedAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDecryptedAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetManagedRuleSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetManagedRuleSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileSdkReleaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileSdkReleaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRateBasedStatementManagedKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRateBasedStatementManagedKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSampledRequestsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSampledRequestsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'HTTPHeader' => [ 'base' => '

Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.

', 'refs' => [ 'HTTPHeaders$member' => NULL, ], ], 'HTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Headers' => '

A complex type that contains the name and value for each header in the sampled web request.

', 'SampledHTTPRequest$RequestHeadersInserted' => '

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

', ], ], 'HTTPMethod' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Method' => '

The HTTP method specified in the sampled web request.

', ], ], 'HTTPRequest' => [ 'base' => '

Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.

', 'refs' => [ 'SampledHTTPRequest$Request' => '

A complex type that contains detailed information about the request.

', ], ], 'HTTPVersion' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$HTTPVersion' => '

The HTTP version specified in the sampled web request, for example, HTTP/1.1.

', ], ], 'HeaderMatchPattern' => [ 'base' => '

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

', 'refs' => [ 'Headers$MatchPattern' => '

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

', ], ], 'HeaderName' => [ 'base' => NULL, 'refs' => [ 'HTTPHeader$Name' => '

The name of the HTTP header.

', ], ], 'HeaderNames' => [ 'base' => NULL, 'refs' => [ 'HeaderMatchPattern$IncludedHeaders' => '

Inspect only the headers that have a key that matches one of the strings specified here.

', 'HeaderMatchPattern$ExcludedHeaders' => '

Inspect only the headers whose keys don\'t match any of the strings specified here.

', ], ], 'HeaderOrder' => [ 'base' => '

Inspect a string containing the list of the request\'s header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

', 'refs' => [ 'FieldToMatch$HeaderOrder' => '

Inspect a string containing the list of the request\'s header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

', ], ], 'HeaderValue' => [ 'base' => NULL, 'refs' => [ 'HTTPHeader$Value' => '

The value of the HTTP header.

', ], ], 'Headers' => [ 'base' => '

Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

', 'refs' => [ 'FieldToMatch$Headers' => '

Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

Only the first 8 KB (8192 bytes) of a request\'s headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

', ], ], 'IPAddress' => [ 'base' => NULL, 'refs' => [ 'IPAddresses$member' => NULL, ], ], 'IPAddressVersion' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', 'IPSet$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', 'RateBasedStatementManagedKeysIPSet$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', ], ], 'IPAddresses' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', 'IPSet$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', 'RateBasedStatementManagedKeysIPSet$Addresses' => '

The IP addresses that are currently blocked.

', 'UpdateIPSetRequest$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', ], ], 'IPSet' => [ 'base' => '

Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

', 'refs' => [ 'GetIPSetResponse$IPSet' => '

', ], ], 'IPSetForwardedIPConfig' => [ 'base' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

', 'refs' => [ 'IPSetReferenceStatement$IPSetForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', ], ], 'IPSetReferenceStatement' => [ 'base' => '

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', 'refs' => [ 'Statement$IPSetReferenceStatement' => '

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', ], ], 'IPSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListIPSetsResponse$IPSets' => '

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'IPSetSummary' => [ 'base' => '

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

', 'refs' => [ 'CreateIPSetResponse$Summary' => '

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

', 'IPSetSummaries$member' => NULL, ], ], 'IPString' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$ClientIP' => '

The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

', ], ], 'ImmunityTimeProperty' => [ 'base' => '

Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

', 'refs' => [ 'CaptchaConfig$ImmunityTimeProperty' => '

Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

', 'ChallengeConfig$ImmunityTimeProperty' => '

Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

', ], ], 'InspectionLevel' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesBotControlRuleSet$InspectionLevel' => '

The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.

', ], ], 'JA3Fingerprint' => [ 'base' => '

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request\'s JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client\'s TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.

You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.

Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

', 'refs' => [ 'FieldToMatch$JA3Fingerprint' => '

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request\'s JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client\'s TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.

You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.

Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

', ], ], 'JsonBody' => [ 'base' => '

Inspect the body of the web request as JSON. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule\'s inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.

Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }

For additional information about this request component option, see JSON body in the WAF Developer Guide.

', 'refs' => [ 'FieldToMatch$JsonBody' => '

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

For information about how to handle oversized request bodies, see the JsonBody object configuration.

', ], ], 'JsonMatchPattern' => [ 'base' => '

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

', 'refs' => [ 'JsonBody$MatchPattern' => '

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

', ], ], 'JsonMatchScope' => [ 'base' => NULL, 'refs' => [ 'JsonBody$MatchScope' => '

The parts of the JSON to match against using the MatchPattern. If you specify ALL, WAF matches against keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', ], ], 'JsonPointerPath' => [ 'base' => NULL, 'refs' => [ 'JsonPointerPaths$member' => NULL, ], ], 'JsonPointerPaths' => [ 'base' => NULL, 'refs' => [ 'JsonMatchPattern$IncludedPaths' => '

Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don\'t use this option to include all paths. Instead, use the All setting.

', ], ], 'Label' => [ 'base' => '

A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest.

', 'refs' => [ 'Labels$member' => NULL, ], ], 'LabelMatchKey' => [ 'base' => NULL, 'refs' => [ 'LabelMatchStatement$Key' => '

The string to match against. The setting you provide for this depends on the match statement\'s Scope setting:

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

', ], ], 'LabelMatchScope' => [ 'base' => NULL, 'refs' => [ 'LabelMatchStatement$Scope' => '

Specify whether you want to match using the label name or just the namespace.

', ], ], 'LabelMatchStatement' => [ 'base' => '

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

', 'refs' => [ 'Statement$LabelMatchStatement' => '

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

', ], ], 'LabelName' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$LabelNamespace' => '

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

', 'Label$Name' => '

The label string.

', 'LabelNameCondition$LabelName' => '

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

', 'LabelSummary$Name' => '

An individual label specification.

', 'ManagedRuleSet$LabelNamespace' => '

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

', 'ManagedRuleSetSummary$LabelNamespace' => '

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

', 'RuleGroup$LabelNamespace' => '

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

', 'WebACL$LabelNamespace' => '

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

', ], ], 'LabelNameCondition' => [ 'base' => '

A single label name condition for a Condition in a logging filter.

', 'refs' => [ 'Condition$LabelNameCondition' => '

A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

', ], ], 'LabelNamespace' => [ 'base' => NULL, 'refs' => [ 'RateLimitLabelNamespace$Namespace' => '

The namespace to use for aggregation.

', ], ], 'LabelSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$AvailableLabels' => '

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

', 'DescribeManagedRuleGroupResponse$ConsumedLabels' => '

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

', 'RuleGroup$AvailableLabels' => '

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

', 'RuleGroup$ConsumedLabels' => '

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

', ], ], 'LabelSummary' => [ 'base' => '

List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:

', 'refs' => [ 'LabelSummaries$member' => NULL, ], ], 'Labels' => [ 'base' => NULL, 'refs' => [ 'Rule$RuleLabels' => '

Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule\'s rule group or web ACL defines the label namespace.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

', 'SampledHTTPRequest$Labels' => '

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule\'s rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

', ], ], 'ListAPIKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAPIKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIPSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIPSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLoggingConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLoggingConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedRuleSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedRuleSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxItems' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsRequest$MaxItems' => '

The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

', ], ], 'ListMobileSdkReleasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileSdkReleasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegexPatternSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRegexPatternSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWebACLsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWebACLsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LockToken' => [ 'base' => NULL, 'refs' => [ 'DeleteFirewallManagerRuleGroupsRequest$WebACLLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteFirewallManagerRuleGroupsResponse$NextWebACLLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteIPSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteRegexPatternSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteRuleGroupRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteWebACLRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetIPSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetManagedRuleSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetRegexPatternSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetRuleGroupResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetWebACLResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'IPSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'ManagedRuleSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'PutManagedRuleSetVersionsRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'PutManagedRuleSetVersionsResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'RegexPatternSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'RuleGroupSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateIPSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateIPSetResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateManagedRuleSetVersionExpiryDateResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRegexPatternSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRegexPatternSetResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateRuleGroupRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRuleGroupResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateWebACLRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateWebACLResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'WebACLSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', ], ], 'LogDestinationConfigs' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$LogDestinationConfigs' => '

The logging destination configuration that you want to associate with the web ACL.

You can associate one logging destination to a web ACL.

', ], ], 'LogScope' => [ 'base' => NULL, 'refs' => [ 'DeleteLoggingConfigurationRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'GetLoggingConfigurationRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'ListLoggingConfigurationsRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'LoggingConfiguration$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', ], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'DeleteLoggingConfigurationRequest$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', 'GetLoggingConfigurationRequest$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', 'LoggingConfiguration$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', ], ], 'LoggingConfiguration' => [ 'base' => '

Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

', 'refs' => [ 'GetLoggingConfigurationResponse$LoggingConfiguration' => '

The LoggingConfiguration for the specified web ACL.

', 'LoggingConfigurations$member' => NULL, 'PutLoggingConfigurationRequest$LoggingConfiguration' => '

', 'PutLoggingConfigurationResponse$LoggingConfiguration' => '

', ], ], 'LoggingConfigurations' => [ 'base' => NULL, 'refs' => [ 'ListLoggingConfigurationsResponse$LoggingConfigurations' => '

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

', ], ], 'LoggingFilter' => [ 'base' => '

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL\'s LoggingConfiguration.

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

', 'refs' => [ 'LoggingConfiguration$LoggingFilter' => '

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

', ], ], 'LoginPathString' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupConfig$LoginPath' => '

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

', ], ], 'ManagedProductDescriptor' => [ 'base' => '

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

', 'refs' => [ 'ManagedProductDescriptors$member' => NULL, ], ], 'ManagedProductDescriptors' => [ 'base' => NULL, 'refs' => [ 'DescribeAllManagedProductsResponse$ManagedProducts' => '

High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

', 'DescribeManagedProductsByVendorResponse$ManagedProducts' => '

High-level information for the managed rule groups owned by the specified vendor.

', ], ], 'ManagedRuleGroupConfig' => [ 'base' => '

Additional information that\'s used by a managed rule group. Many managed rule groups don\'t require this.

The rule groups used for intelligent threat mitigation require additional configuration:

For example specifications, see the examples section of CreateWebACL.

', 'refs' => [ 'ManagedRuleGroupConfigs$member' => NULL, ], ], 'ManagedRuleGroupConfigs' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$ManagedRuleGroupConfigs' => '

Additional information that\'s used by a managed rule group. Many managed rule groups don\'t require this.

The rule groups used for intelligent threat mitigation require additional configuration:

', ], ], 'ManagedRuleGroupStatement' => [ 'base' => '

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

', 'refs' => [ 'FirewallManagerStatement$ManagedRuleGroupStatement' => '

A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

', 'Statement$ManagedRuleGroupStatement' => '

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

', ], ], 'ManagedRuleGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagedRuleGroupsResponse$ManagedRuleGroups' => '

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleGroupSummary' => [ 'base' => '

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.

', 'refs' => [ 'ManagedRuleGroupSummaries$member' => NULL, ], ], 'ManagedRuleGroupVersion' => [ 'base' => '

Describes a single version of a managed rule group.

', 'refs' => [ 'ManagedRuleGroupVersions$member' => NULL, ], ], 'ManagedRuleGroupVersions' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagedRuleGroupVersionsResponse$Versions' => '

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleSet' => [ 'base' => '

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'GetManagedRuleSetResponse$ManagedRuleSet' => '

The managed rule set that you requested.

', ], ], 'ManagedRuleSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListManagedRuleSetsResponse$ManagedRuleSets' => '

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleSetSummary' => [ 'base' => '

High-level information for a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'ManagedRuleSetSummaries$member' => NULL, ], ], 'ManagedRuleSetVersion' => [ 'base' => '

Information for a single version of a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'PublishedVersions$value' => NULL, ], ], 'MapMatchScope' => [ 'base' => NULL, 'refs' => [ 'Cookies$MatchScope' => '

The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', 'Headers$MatchScope' => '

The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', ], ], 'Method' => [ 'base' => '

Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "Method": {}

', 'refs' => [ 'FieldToMatch$Method' => '

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsRequest$RuleMetricName' => '

The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.

', 'VisibilityConfig$MetricName' => '

A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can\'t contain whitespace or metric names that are reserved for WAF, for example All and Default_Action.

', ], ], 'MobileSdkRelease' => [ 'base' => '

Information for a release of the mobile SDK, including release notes and tags.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'refs' => [ 'GetMobileSdkReleaseResponse$MobileSdkRelease' => '

Information for a specified SDK release, including release notes and tags.

', ], ], 'NextMarker' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAPIKeysResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupVersionsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupVersionsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListIPSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListIPSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListLoggingConfigurationsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListLoggingConfigurationsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListManagedRuleSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListManagedRuleSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListMobileSdkReleasesRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListMobileSdkReleasesResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRegexPatternSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRegexPatternSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRuleGroupsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRuleGroupsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListTagsForResourceRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListTagsForResourceResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListWebACLsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListWebACLsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', ], ], 'NoneAction' => [ 'base' => '

Specifies that WAF should do nothing. This is used for the OverrideAction setting on a Rule when the rule uses a rule group reference statement.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

JSON specification: "None": {}

', 'refs' => [ 'OverrideAction$None' => '

Don\'t override the rule group evaluation result. This is the most common setting.

', ], ], 'NotStatement' => [ 'base' => '

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

', 'refs' => [ 'Statement$NotStatement' => '

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

', ], ], 'OrStatement' => [ 'base' => '

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

', 'refs' => [ 'Statement$OrStatement' => '

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

', ], ], 'OutputUrl' => [ 'base' => NULL, 'refs' => [ 'GetWebACLResponse$ApplicationIntegrationURL' => '

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

', 'ListAPIKeysResponse$ApplicationIntegrationURL' => '

The CAPTCHA application integration URL, for use in your JavaScript implementation.

', ], ], 'OverrideAction' => [ 'base' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'refs' => [ 'FirewallManagerRuleGroup$OverrideAction' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'Rule$OverrideAction' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', ], ], 'OversizeHandling' => [ 'base' => NULL, 'refs' => [ 'Body$OversizeHandling' => '

What WAF should do if the body is larger than WAF can inspect.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

The options for oversize handling are the following:

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

', 'Cookies$OversizeHandling' => '

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

The options for oversize handling are the following:

', 'HeaderOrder$OversizeHandling' => '

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

', 'Headers$OversizeHandling' => '

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

', 'JsonBody$OversizeHandling' => '

What WAF should do if the body is larger than WAF can inspect.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

The options for oversize handling are the following:

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

', ], ], 'PaginationLimit' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListAvailableManagedRuleGroupVersionsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListAvailableManagedRuleGroupsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListIPSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListLoggingConfigurationsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListManagedRuleSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListMobileSdkReleasesRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListRegexPatternSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListRuleGroupsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListTagsForResourceRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListWebACLsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', ], ], 'ParameterExceptionField' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Field' => '

The settings where the invalid parameter was found.

', ], ], 'ParameterExceptionParameter' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Parameter' => '

The invalid parameter that resulted in the exception.

', ], ], 'PasswordField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s password.

This data type is used in the RequestInspection and RequestInspectionACFP data types.

', 'refs' => [ 'ManagedRuleGroupConfig$PasswordField' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$PasswordField' => '

The name of the field in the request payload that contains your customer\'s password.

How you specify this depends on the request inspection payload type.

', 'RequestInspectionACFP$PasswordField' => '

The name of the field in the request payload that contains your customer\'s password.

How you specify this depends on the request inspection payload type.

', ], ], 'PayloadType' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupConfig$PayloadType' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$PayloadType' => '

The payload type for your login endpoint, either JSON or form encoded.

', 'RequestInspectionACFP$PayloadType' => '

The payload type for your account creation endpoint, either JSON or form encoded.

', ], ], 'PhoneNumberField' => [ 'base' => '

The name of a field in the request payload that contains part or all of your customer\'s primary phone number.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'PhoneNumberFields$member' => NULL, ], ], 'PhoneNumberFields' => [ 'base' => NULL, 'refs' => [ 'RequestInspectionACFP$PhoneNumberFields' => '

The names of the fields in the request payload that contain your customer\'s primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

', ], ], 'Platform' => [ 'base' => NULL, 'refs' => [ 'GenerateMobileSdkReleaseUrlRequest$Platform' => '

The device platform.

', 'GetMobileSdkReleaseRequest$Platform' => '

The device platform.

', 'ListMobileSdkReleasesRequest$Platform' => '

The device platform to retrieve the list for.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetPermissionPolicyResponse$Policy' => '

The IAM policy that is attached to the specified rule group.

', 'PutPermissionPolicyRequest$Policy' => '

The policy to attach to the specified rule group.

The policy specifications must conform to the following:

For more information, see IAM Policies.

', ], ], 'PopulationSize' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsResponse$PopulationSize' => '

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.

', ], ], 'PositionalConstraint' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$PositionalConstraint' => '

The area within the portion of the web request that you want WAF to search for SearchString. Valid values include the following:

CONTAINS

The specified part of the web request must include the value of SearchString, but the location doesn\'t matter.

CONTAINS_WORD

The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

EXACTLY

The value of the specified part of the web request must exactly match the value of SearchString.

STARTS_WITH

The value of SearchString must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of SearchString must appear at the end of the specified part of the web request.

', ], ], 'ProductDescription' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductDescription' => '

A short description of the managed rule group.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductId' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'ProductLink' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductLink' => '

For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

', ], ], 'ProductTitle' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductTitle' => '

The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

', ], ], 'PublishedVersions' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleSet$PublishedVersions' => '

The versions of this managed rule set that are available for use by customers.

', ], ], 'PutLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutManagedRuleSetVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutManagedRuleSetVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutPermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryString' => [ 'base' => '

Inspect the query string of the web request. This is the part of a URL that appears after a ? character, if any.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "QueryString": {}

', 'refs' => [ 'FieldToMatch$QueryString' => '

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

', ], ], 'RateBasedStatement' => [ 'base' => '

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

If you change any of these settings in a rule that\'s currently in use, the change resets the rule\'s rate limiting counts. This can pause the rule\'s rate limiting activities for up to a minute.

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

The rule would create different aggregation instances according to your aggregation criteria, for example:

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

', 'refs' => [ 'Statement$RateBasedStatement' => '

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

If you change any of these settings in a rule that\'s currently in use, the change resets the rule\'s rate limiting counts. This can pause the rule\'s rate limiting activities for up to a minute.

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

The rule would create different aggregation instances according to your aggregation criteria, for example:

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

', ], ], 'RateBasedStatementAggregateKeyType' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$AggregateKeyType' => '

Setting that indicates how to aggregate the request counts.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

', ], ], 'RateBasedStatementCustomKey' => [ 'base' => '

Specifies a single custom aggregate key for a rate-base rule.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

', 'refs' => [ 'RateBasedStatementCustomKeys$member' => NULL, ], ], 'RateBasedStatementCustomKeys' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$CustomKeys' => '

Specifies the aggregate keys to use in a rate-base rule.

', ], ], 'RateBasedStatementManagedKeysIPSet' => [ 'base' => '

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

A rate-based rule applies its rule action to requests from IP addresses that are in the rule\'s managed keys list and that match the rule\'s scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

', 'refs' => [ 'GetRateBasedStatementManagedKeysResponse$ManagedKeysIPV4' => '

The keys that are of Internet Protocol version 4 (IPv4).

', 'GetRateBasedStatementManagedKeysResponse$ManagedKeysIPV6' => '

The keys that are of Internet Protocol version 6 (IPv6).

', ], ], 'RateLimit' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$Limit' => '

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

Examples:

', ], ], 'RateLimitCookie' => [ 'base' => '

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$Cookie' => '

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitForwardedIP' => [ 'base' => '

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement\'s AggregateKeyType.

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn\'t explicitly use this data type.

JSON specification: "ForwardedIP": {}

When you use this specification, you must also configure the forwarded IP address in the rate-based statement\'s ForwardedIPConfig.

', 'refs' => [ 'RateBasedStatementCustomKey$ForwardedIP' => '

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement\'s AggregateKeyType.

With this option, you must specify the header to use in the rate-based rule\'s ForwardedIPConfig property.

', ], ], 'RateLimitHTTPMethod' => [ 'base' => '

Specifies the request\'s HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

JSON specification: "RateLimitHTTPMethod": {}

', 'refs' => [ 'RateBasedStatementCustomKey$HTTPMethod' => '

Use the request\'s HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

', ], ], 'RateLimitHeader' => [ 'base' => '

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$Header' => '

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitIP' => [ 'base' => '

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement\'s AggregateKeyType, specify IP.

JSON specification: "RateLimitIP": {}

', 'refs' => [ 'RateBasedStatementCustomKey$IP' => '

Use the request\'s originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement\'s AggregateKeyType.

', ], ], 'RateLimitLabelNamespace' => [ 'base' => '

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

', 'refs' => [ 'RateBasedStatementCustomKey$LabelNamespace' => '

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

', ], ], 'RateLimitQueryArgument' => [ 'base' => '

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$QueryArgument' => '

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitQueryString' => [ 'base' => '

Specifies the request\'s query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$QueryString' => '

Use the request\'s query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

', ], ], 'RateLimitUriPath' => [ 'base' => '

Specifies the request\'s URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$UriPath' => '

Use the request\'s URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

', ], ], 'RedactedFields' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$RedactedFields' => '

The parts of the request that you want to keep out of the logs.

For example, if you redact the SingleHeader field, the HEADER field in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting.

Redaction applies only to the component that\'s specified in the rule\'s FieldToMatch setting, so the SingleHeader redaction doesn\'t apply to rules that use the Headers FieldToMatch.

You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, and Method.

This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.

', ], ], 'Regex' => [ 'base' => '

A single regular expression. This is used in a RegexPatternSet.

', 'refs' => [ 'RegularExpressionList$member' => NULL, ], ], 'RegexMatchStatement' => [ 'base' => '

A rule statement used to search web request components for a match against a single regular expression.

', 'refs' => [ 'Statement$RegexMatchStatement' => '

A rule statement used to search web request components for a match against a single regular expression.

', ], ], 'RegexPatternSet' => [ 'base' => '

Contains one or more regular expressions.

WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

', 'refs' => [ 'GetRegexPatternSetResponse$RegexPatternSet' => '

', ], ], 'RegexPatternSetReferenceStatement' => [ 'base' => '

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', 'refs' => [ 'Statement$RegexPatternSetReferenceStatement' => '

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', ], ], 'RegexPatternSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListRegexPatternSetsResponse$RegexPatternSets' => '

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'RegexPatternSetSummary' => [ 'base' => '

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

', 'refs' => [ 'CreateRegexPatternSetResponse$Summary' => '

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

', 'RegexPatternSetSummaries$member' => NULL, ], ], 'RegexPatternString' => [ 'base' => NULL, 'refs' => [ 'Regex$RegexString' => '

The string representing the regular expression.

', 'RegexMatchStatement$RegexString' => '

The string representing the regular expression.

', ], ], 'RegistrationPagePathString' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$RegistrationPagePath' => '

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

This page must accept GET text/html requests.

For example, for the URL https://example.com/web/registration, you would provide the path /web/registration. Registration page paths that start with the path that you provide are considered a match. For example /web/registration matches the registration paths /web/registration, /web/registration/, /web/registrationPage, and /web/registration/thisPage, but doesn\'t match the path /home/web/registration or /website/registration.

', ], ], 'RegularExpressionList' => [ 'base' => NULL, 'refs' => [ 'CreateRegexPatternSetRequest$RegularExpressionList' => '

Array of regular expression strings.

', 'RegexPatternSet$RegularExpressionList' => '

The regular expression patterns in the set.

', 'UpdateRegexPatternSetRequest$RegularExpressionList' => '

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'MobileSdkRelease$ReleaseNotes' => '

Notes describing the release.

', ], ], 'ReleaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListMobileSdkReleasesResponse$ReleaseSummaries' => '

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ReleaseSummary' => [ 'base' => '

High level information for an SDK release.

', 'refs' => [ 'ReleaseSummaries$member' => NULL, ], ], 'RequestBody' => [ 'base' => NULL, 'refs' => [ 'AssociationConfig$RequestBody' => '

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', ], ], 'RequestBodyAssociatedResourceTypeConfig' => [ 'base' => '

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

This is used in the AssociationConfig of the web ACL.

', 'refs' => [ 'RequestBody$value' => NULL, ], ], 'RequestInspection' => [ 'base' => '

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

', 'refs' => [ 'AWSManagedRulesATPRuleSet$RequestInspection' => '

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

', ], ], 'RequestInspectionACFP' => [ 'base' => '

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.

', 'refs' => [ 'AWSManagedRulesACFPRuleSet$RequestInspection' => '

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AssociateWebACLRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

', 'AssociateWebACLRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

The ARN must be in one of the following formats:

', 'DeleteFirewallManagerRuleGroupsRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL.

', 'DeleteLoggingConfigurationRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

', 'DeletePermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.

You must be the owner of the rule group to perform this operation.

', 'DescribeManagedRuleGroupResponse$SnsTopicArn' => '

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that\'s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

', 'DisassociateWebACLRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

The ARN must be in one of the following formats:

', 'GetLoggingConfigurationRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

', 'GetPermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.

', 'GetRuleGroupRequest$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'GetSampledRequestsRequest$WebAclArn' => '

The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

', 'GetWebACLForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

The ARN must be in one of the following formats:

', 'IPSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'IPSetReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the IPSet that this statement references.

', 'IPSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ListResourcesForWebACLRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL.

', 'ListTagsForResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'LogDestinationConfigs$member' => NULL, 'LoggingConfiguration$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

', 'ManagedProductDescriptor$SnsTopicArn' => '

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that\'s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

', 'ManagedRuleSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ManagedRuleSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ManagedRuleSetVersion$AssociatedRuleGroupArn' => '

The Amazon Resource Name (ARN) of the vendor rule group that\'s used to define the published version of your managed rule group.

', 'PutPermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

', 'RegexPatternSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RegexPatternSetReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

', 'RegexPatternSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ResourceArns$member' => NULL, 'RuleGroup$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RuleGroupReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RuleGroupSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'TagInfoForResource$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'TagResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'VersionToPublish$AssociatedRuleGroupArn' => '

The Amazon Resource Name (ARN) of the vendor\'s rule group that\'s used in the published managed rule group version.

', 'WebACL$ARN' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

', 'WebACLSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', ], ], 'ResourceArns' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForWebACLResponse$ResourceArns' => '

The array of Amazon Resource Names (ARNs) of the associated resources.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForWebACLRequest$ResourceType' => '

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

If you don\'t provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.

Default: APPLICATION_LOAD_BALANCER

', ], ], 'ResponseCode' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$ResponseCode' => '

The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.

', 'ChallengeResponse$ResponseCode' => '

The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.

', ], ], 'ResponseContent' => [ 'base' => NULL, 'refs' => [ 'CustomResponseBody$Content' => '

The payload of the custom response.

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'ResponseContentType' => [ 'base' => NULL, 'refs' => [ 'CustomResponseBody$ContentType' => '

The type of content in the payload that you are defining in the Content string.

', ], ], 'ResponseInspection' => [ 'base' => '

The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.

This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.

Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can\'t configure more than one component for inspection. If you don\'t configure any of the response inspection options, response inspection is disabled.

', 'refs' => [ 'AWSManagedRulesACFPRuleSet$ResponseInspection' => '

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.

', 'AWSManagedRulesATPRuleSet$ResponseInspection' => '

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

', ], ], 'ResponseInspectionBodyContains' => [ 'base' => '

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$BodyContains' => '

Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

', ], ], 'ResponseInspectionBodyContainsFailureStrings' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContains$FailureStrings' => '

Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

JSON example: "FailureStrings": [ "Request failed" ]

', ], ], 'ResponseInspectionBodyContainsSuccessStrings' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContains$SuccessStrings' => '

Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

JSON examples: "SuccessStrings": [ "Login successful" ] and "SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]

', ], ], 'ResponseInspectionHeader' => [ 'base' => '

Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$Header' => '

Configures inspection of the response header for success and failure indicators.

', ], ], 'ResponseInspectionHeaderFailureValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$FailureValues' => '

Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]

', ], ], 'ResponseInspectionHeaderName' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$Name' => '

The name of the header to match against. The name must be an exact match, including case.

JSON example: "Name": [ "RequestResult" ]

', ], ], 'ResponseInspectionHeaderSuccessValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$SuccessValues' => '

Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]

', ], ], 'ResponseInspectionJson' => [ 'base' => '

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$Json' => '

Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

', ], ], 'ResponseInspectionJsonFailureValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionJson$FailureValues' => '

Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "FailureValues": [ "False", "Failed" ]

', ], ], 'ResponseInspectionJsonSuccessValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionJson$SuccessValues' => '

Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "SuccessValues": [ "True", "Succeeded" ]

', ], ], 'ResponseInspectionStatusCode' => [ 'base' => '

Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$StatusCode' => '

Configures inspection of the response status code for success and failure indicators.

', ], ], 'ResponseInspectionStatusCodeFailureCodes' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCode$FailureCodes' => '

Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

JSON example: "FailureCodes": [ 400, 404 ]

', ], ], 'ResponseInspectionStatusCodeSuccessCodes' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCode$SuccessCodes' => '

Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

JSON example: "SuccessCodes": [ 200, 201 ]

', ], ], 'ResponseStatusCode' => [ 'base' => NULL, 'refs' => [ 'CustomResponse$ResponseCode' => '

The HTTP status code to return to the client.

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

', 'SampledHTTPRequest$ResponseCodeSent' => '

The response code that was sent for the request.

', ], ], 'Rule' => [ 'base' => '

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'RuleAction' => [ 'base' => '

The action that WAF should take on a web request when it matches a rule\'s statement. Settings at the web ACL level can override the rule action setting.

', 'refs' => [ 'Rule$Action' => '

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

You must specify either this Action setting or the rule OverrideAction setting, but not both:

', 'RuleActionOverride$ActionToUse' => '

The override action to use, in place of the configured action of the rule in the rule group.

', 'RuleSummary$Action' => '

The action that WAF should take on a web request when it matches a rule\'s statement. Settings at the web ACL level can override the rule action setting.

', ], ], 'RuleActionOverride' => [ 'base' => '

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', 'refs' => [ 'RuleActionOverrides$member' => NULL, ], ], 'RuleActionOverrides' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$RuleActionOverrides' => '

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', 'RuleGroupReferenceStatement$RuleActionOverrides' => '

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', ], ], 'RuleGroup' => [ 'base' => '

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

', 'refs' => [ 'GetRuleGroupResponse$RuleGroup' => '

', ], ], 'RuleGroupReferenceStatement' => [ 'base' => '

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

', 'refs' => [ 'FirewallManagerStatement$RuleGroupReferenceStatement' => '

A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

', 'Statement$RuleGroupReferenceStatement' => '

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

', ], ], 'RuleGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListRuleGroupsResponse$RuleGroups' => '

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

', ], ], 'RuleGroupSummary' => [ 'base' => '

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'refs' => [ 'CreateRuleGroupResponse$Summary' => '

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'RuleGroupSummaries$member' => NULL, ], ], 'RulePriority' => [ 'base' => NULL, 'refs' => [ 'FirewallManagerRuleGroup$Priority' => '

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don\'t need to be consecutive, but they must all be different.

', 'Rule$Priority' => '

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don\'t need to be consecutive, but they must all be different.

', ], ], 'RuleSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$Rules' => '

', ], ], 'RuleSummary' => [ 'base' => '

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'refs' => [ 'RuleSummaries$member' => NULL, ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityRequest$Rules' => '

An array of Rule that you\'re configuring to use in a rule group or web ACL.

', 'CreateRuleGroupRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'CreateWebACLRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'RuleGroup$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'UpdateRuleGroupRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'UpdateWebACLRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'WebACL$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', ], ], 'SampleWeight' => [ 'base' => NULL, 'refs' => [ 'SampledHTTPRequest$Weight' => '

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

', ], ], 'SampledHTTPRequest' => [ 'base' => '

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.

', 'refs' => [ 'SampledHTTPRequests$member' => NULL, ], ], 'SampledHTTPRequests' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsResponse$SampledRequests' => '

A complex type that contains detailed information about each of the requests in the sample.

', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeAllManagedProductsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeManagedProductsByVendorRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeManagedRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetDecryptedAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetManagedRuleSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRateBasedStatementManagedKeysRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetSampledRequestsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAPIKeysRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAvailableManagedRuleGroupVersionsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAvailableManagedRuleGroupsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListIPSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListLoggingConfigurationsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListManagedRuleSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListRegexPatternSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListRuleGroupsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListWebACLsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'PutManagedRuleSetVersionsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', ], ], 'SearchString' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$SearchString' => '

A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.

Valid values depend on the component that you specify for inspection in FieldToMatch:

If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

If you\'re using the WAF API

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.

For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.

If you\'re using the CLI or one of the Amazon Web Services SDKs

The value that you want WAF to search for. The SDK automatically base64 encodes the value.

', ], ], 'SensitivityLevel' => [ 'base' => NULL, 'refs' => [ 'SqliMatchStatement$SensitivityLevel' => '

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide.

LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

Default: LOW

', ], ], 'SingleCookieName' => [ 'base' => NULL, 'refs' => [ 'CookieNames$member' => NULL, ], ], 'SingleHeader' => [ 'base' => '

Inspect one of the headers in the web request, identified by name, for example, User-Agent or Referer. The name isn\'t case sensitive.

You can filter and inspect all headers with the FieldToMatch setting Headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "SingleHeader": { "Name": "haystack" }

', 'refs' => [ 'FieldToMatch$SingleHeader' => '

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn\'t case sensitive.

Example JSON: "SingleHeader": { "Name": "haystack" }

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

', ], ], 'SingleQueryArgument' => [ 'base' => '

Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion. The name isn\'t case sensitive.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

', 'refs' => [ 'FieldToMatch$SingleQueryArgument' => '

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn\'t case sensitive.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

', ], ], 'Size' => [ 'base' => NULL, 'refs' => [ 'SizeConstraintStatement$Size' => '

The size, in byte, to compare to the request part, after any transformations.

', ], ], 'SizeConstraintStatement' => [ 'base' => '

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

', 'refs' => [ 'Statement$SizeConstraintStatement' => '

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

', ], ], 'SizeInspectionLimit' => [ 'base' => NULL, 'refs' => [ 'RequestBodyAssociatedResourceTypeConfig$DefaultSizeInspectionLimit' => '

Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.

Default: 16 KB (16,384 bytes)

', ], ], 'SolveTimestamp' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$SolveTimestamp' => '

The time that the CAPTCHA was last solved for the supplied token.

', 'ChallengeResponse$SolveTimestamp' => '

The time that the challenge was last solved for the supplied token.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'WAFLimitsExceededException$SourceType' => '

Source type for the exception.

', ], ], 'SqliMatchStatement' => [ 'base' => '

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

', 'refs' => [ 'Statement$SqliMatchStatement' => '

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

', ], ], 'Statement' => [ 'base' => '

The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.

For example specifications, see the examples section of CreateWebACL.

', 'refs' => [ 'ManagedRuleGroupStatement$ScopeDownStatement' => '

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

', 'NotStatement$Statement' => '

The statement to negate. You can use any statement that can be nested.

', 'RateBasedStatement$ScopeDownStatement' => '

An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

', 'Rule$Statement' => '

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

', 'Statements$member' => NULL, ], ], 'Statements' => [ 'base' => NULL, 'refs' => [ 'AndStatement$Statements' => '

The statements to combine with AND logic. You can use any statements that can be nested.

', 'OrStatement$Statements' => '

The statements to combine with OR logic. You can use any statements that can be nested.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesATPRuleSet$LoginPath' => '

The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn\'t match the login path /home/web/login or /website/login.

The rule group inspects only HTTP POST requests to your specified login endpoint.

', ], ], 'SuccessCode' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCodeSuccessCodes$member' => NULL, ], ], 'SuccessValue' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContainsSuccessStrings$member' => NULL, 'ResponseInspectionHeaderSuccessValues$member' => NULL, 'ResponseInspectionJsonSuccessValues$member' => NULL, ], ], 'Tag' => [ 'base' => '

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagInfoForResource' => [ 'base' => '

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'refs' => [ 'ListTagsForResourceResponse$TagInfoForResource' => '

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

An array of keys identifying the tags to disassociate from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateRegexPatternSetRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateRuleGroupRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateWebACLRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'MobileSdkRelease$Tags' => '

Tags that are associated with the release.

', 'TagInfoForResource$TagList' => '

The array of Tag objects defined for the resource.

', 'TagResourceRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

', ], ], 'TextTransformation' => [ 'base' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

', 'refs' => [ 'TextTransformations$member' => NULL, ], ], 'TextTransformationPriority' => [ 'base' => NULL, 'refs' => [ 'TextTransformation$Priority' => '

Sets the relative processing order for multiple transformations. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don\'t need to be consecutive, but they must all be different.

', ], ], 'TextTransformationType' => [ 'base' => NULL, 'refs' => [ 'TextTransformation$Type' => '

For detailed descriptions of each of the transformation types, see Text transformations in the WAF Developer Guide.

', ], ], 'TextTransformations' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitCookie$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitHeader$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitQueryArgument$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitQueryString$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitUriPath$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RegexMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RegexPatternSetReferenceStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'SizeConstraintStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'SqliMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'XssMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', ], ], 'TimeWindow' => [ 'base' => '

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request.

', 'refs' => [ 'GetSampledRequestsRequest$TimeWindow' => '

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that\'s earlier than three hours ago, WAF sets it to three hours ago.

', 'GetSampledRequestsResponse$TimeWindow' => '

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

', ], ], 'TimeWindowDay' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleSetVersion$ForecastedLifetime' => '

The amount of time you expect this version of your managed rule group to last, in days.

', 'VersionToPublish$ForecastedLifetime' => '

The amount of time the vendor expects this version of the managed rule group to last, in days.

', ], ], 'TimeWindowSecond' => [ 'base' => NULL, 'refs' => [ 'ImmunityTimeProperty$ImmunityTime' => '

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

For the Challenge action, the minimum setting is 300.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$CreationTimestamp' => '

The date and time that the key was created.

', 'GetDecryptedAPIKeyResponse$CreationTimestamp' => '

The date and time that the key was created.

', 'ManagedRuleGroupVersion$LastUpdateTimestamp' => '

The date and time that the managed rule group owner updated the rule group version information.

', 'ManagedRuleSetVersion$PublishTimestamp' => '

The time that you first published this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'ManagedRuleSetVersion$LastUpdateTimestamp' => '

The last time that you updated this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'ManagedRuleSetVersion$ExpiryTimestamp' => '

The time that this version is set to expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'MobileSdkRelease$Timestamp' => '

The timestamp of the release.

', 'ReleaseSummary$Timestamp' => '

The timestamp of the release.

', 'SampledHTTPRequest$Timestamp' => '

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

', 'TimeWindow$StartTime' => '

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

', 'TimeWindow$EndTime' => '

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$ExpiryTimestamp' => '

The time that you want the version to expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'UpdateManagedRuleSetVersionExpiryDateResponse$ExpiryTimestamp' => '

The time that the version will expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', ], ], 'TokenDomain' => [ 'base' => NULL, 'refs' => [ 'APIKeyTokenDomains$member' => NULL, 'TokenDomains$member' => NULL, ], ], 'TokenDomains' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$TokenDomains' => '

The token domains that are defined in this API key.

', 'CreateWebACLRequest$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', 'GetDecryptedAPIKeyResponse$TokenDomains' => '

The token domains that are defined in this API key.

', 'UpdateWebACLRequest$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', 'WebACL$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

', ], ], 'URIString' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$URI' => '

The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateManagedRuleSetVersionExpiryDateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateManagedRuleSetVersionExpiryDateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'UriPath' => [ 'base' => '

Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "UriPath": {}

', 'refs' => [ 'FieldToMatch$UriPath' => '

Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

', ], ], 'UsernameField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s username.

This data type is used in the RequestInspection and RequestInspectionACFP data types.

', 'refs' => [ 'ManagedRuleGroupConfig$UsernameField' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$UsernameField' => '

The name of the field in the request payload that contains your customer\'s username.

How you specify this depends on the request inspection payload type.

', 'RequestInspectionACFP$UsernameField' => '

The name of the field in the request payload that contains your customer\'s username.

How you specify this depends on the request inspection payload type.

', ], ], 'VendorName' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedProductsByVendorRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'DescribeManagedRuleGroupRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ListAvailableManagedRuleGroupVersionsRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedProductDescriptor$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedRuleGroupStatement$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedRuleGroupSummary$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', ], ], 'VersionKeyString' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupRequest$VersionName' => '

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don\'t provide this, WAF uses the vendor\'s default version.

', 'DescribeManagedRuleGroupResponse$VersionName' => '

The managed rule group\'s version.

', 'GenerateMobileSdkReleaseUrlRequest$ReleaseVersion' => '

The release version. For the latest available version, specify LATEST.

', 'GetMobileSdkReleaseRequest$ReleaseVersion' => '

The release version. For the latest available version, specify LATEST.

', 'ListAvailableManagedRuleGroupVersionsResponse$CurrentDefaultVersion' => '

The name of the version that\'s currently set as the default.

', 'ManagedRuleGroupStatement$Version' => '

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don\'t specify this, WAF uses the vendor\'s default version, and then keeps the version at the vendor\'s default when the vendor updates the managed rule group settings.

', 'ManagedRuleGroupVersion$Name' => '

The version name.

', 'ManagedRuleSet$RecommendedVersion' => '

The version that you would like your customers to use.

', 'MobileSdkRelease$ReleaseVersion' => '

The release version.

', 'PublishedVersions$key' => NULL, 'PutManagedRuleSetVersionsRequest$RecommendedVersion' => '

The version of the named managed rule group that you\'d like your customers to choose, from among your version offerings.

', 'ReleaseSummary$ReleaseVersion' => '

The release version.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$VersionToExpire' => '

The version that you want to remove from your list of offerings for the named managed rule group.

', 'UpdateManagedRuleSetVersionExpiryDateResponse$ExpiringVersion' => '

The version that is set to expire.

', 'VersionsToPublish$key' => NULL, ], ], 'VersionToPublish' => [ 'base' => '

A version of the named managed rule group, that the rule group\'s vendor publishes for use by customers.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'VersionsToPublish$value' => NULL, ], ], 'VersionsToPublish' => [ 'base' => NULL, 'refs' => [ 'PutManagedRuleSetVersionsRequest$VersionsToPublish' => '

The versions of the named managed rule group that you want to offer to your customers.

', ], ], 'VisibilityConfig' => [ 'base' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'refs' => [ 'CreateRuleGroupRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'CreateWebACLRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'FirewallManagerRuleGroup$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'Rule$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

If you change the name of a Rule after you create it and you want the rule\'s metric name to reflect the change, update the metric name as well. WAF doesn\'t automatically update the metric name.

', 'RuleGroup$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'UpdateRuleGroupRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'UpdateWebACLRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'WebACL$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', ], ], 'WAFAssociatedItemException' => [ 'base' => '

WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

', 'refs' => [], ], 'WAFConfigurationWarningException' => [ 'base' => '

The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

Provide the handling configuration and retry your operation.

Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true).

', 'refs' => [], ], 'WAFDuplicateItemException' => [ 'base' => '

WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

', 'refs' => [], ], 'WAFExpiredManagedRuleGroupVersionException' => [ 'base' => '

The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.

', 'refs' => [], ], 'WAFInternalErrorException' => [ 'base' => '

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

', 'refs' => [], ], 'WAFInvalidOperationException' => [ 'base' => '

The operation isn\'t valid.

', 'refs' => [], ], 'WAFInvalidParameterException' => [ 'base' => '

The operation failed because WAF didn\'t recognize a parameter in the request. For example:

', 'refs' => [], ], 'WAFInvalidPermissionPolicyException' => [ 'base' => '

The operation failed because the specified policy isn\'t in the proper format.

The policy specifications must conform to the following:

For more information, see IAM Policies.

', 'refs' => [], ], 'WAFInvalidResourceException' => [ 'base' => '

WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

', 'refs' => [], ], 'WAFLimitsExceededException' => [ 'base' => '

WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

', 'refs' => [], ], 'WAFLogDestinationPermissionIssueException' => [ 'base' => '

The operation failed because you don\'t have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the WAF Developer Guide.

', 'refs' => [], ], 'WAFNonexistentItemException' => [ 'base' => '

WAF couldn’t perform the operation because your resource doesn\'t exist. If you\'ve just created a resource that you\'re using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

', 'refs' => [], ], 'WAFOptimisticLockException' => [ 'base' => '

WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

', 'refs' => [], ], 'WAFServiceLinkedRoleErrorException' => [ 'base' => '

WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

', 'refs' => [], ], 'WAFSubscriptionNotFoundException' => [ 'base' => '

You tried to use a managed rule group that\'s available by subscription, but you aren\'t subscribed to it yet.

', 'refs' => [], ], 'WAFTagOperationException' => [ 'base' => '

An error occurred during the tagging operation. Retry your request.

', 'refs' => [], ], 'WAFTagOperationInternalErrorException' => [ 'base' => '

WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

', 'refs' => [], ], 'WAFUnavailableEntityException' => [ 'base' => '

WAF couldn’t retrieve a resource that you specified for this operation. If you\'ve just created a resource that you\'re using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

', 'refs' => [], ], 'WAFUnsupportedAggregateKeyTypeException' => [ 'base' => '

The rule that you\'ve named doesn\'t aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

', 'refs' => [], ], 'WebACL' => [ 'base' => '

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

', 'refs' => [ 'GetWebACLForResourceResponse$WebACL' => '

The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.

', 'GetWebACLResponse$WebACL' => '

The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

', ], ], 'WebACLSummaries' => [ 'base' => NULL, 'refs' => [ 'ListWebACLsResponse$WebACLs' => '

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

', ], ], 'WebACLSummary' => [ 'base' => '

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

', 'refs' => [ 'CreateWebACLResponse$Summary' => '

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

', 'WebACLSummaries$member' => NULL, ], ], 'XssMatchStatement' => [ 'base' => '

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

', 'refs' => [ 'Statement$XssMatchStatement' => '

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'WAF

This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

If you used WAF prior to this release, you can\'t use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.

For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.

This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the WAF Developer Guide.

You can make calls using the endpoints listed in WAF endpoints and quotas.

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that\'s tailored to the programming language or platform that you\'re using. For more information, see Amazon Web Services SDKs.

We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:

', 'operations' => [ 'AssociateWebACL' => '

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

For Amazon CloudFront, don\'t use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'CheckCapacity' => '

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'CreateAPIKey' => '

Creates an API key that contains a set of token domains.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

', 'CreateIPSet' => '

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you\'re receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

', 'CreateRegexPatternSet' => '

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

', 'CreateRuleGroup' => '

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

', 'CreateWebACL' => '

Creates a WebACL per the specifications provided.

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

', 'DeleteAPIKey' => '

Deletes the specified API key.

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

', 'DeleteFirewallManagerRuleGroups' => '

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

', 'DeleteIPSet' => '

Deletes the specified IPSet.

', 'DeleteLoggingConfiguration' => '

Deletes the LoggingConfiguration from the specified web ACL.

', 'DeletePermissionPolicy' => '

Permanently deletes an IAM policy from the specified rule group.

You must be the owner of the rule group to perform this operation.

', 'DeleteRegexPatternSet' => '

Deletes the specified RegexPatternSet.

', 'DeleteRuleGroup' => '

Deletes the specified RuleGroup.

', 'DeleteWebACL' => '

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

Before deleting any web ACL, first disassociate it from all resources.

', 'DescribeAllManagedProducts' => '

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

', 'DescribeManagedProductsByVendor' => '

Provides high-level information for the managed rule groups owned by a specific vendor.

', 'DescribeManagedRuleGroup' => '

Provides high-level information for a managed rule group, including descriptions of the rules.

', 'DisassociateWebACL' => '

Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

For Amazon CloudFront, don\'t use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.

', 'GenerateMobileSdkReleaseUrl' => '

Generates a presigned download URL for the specified release of the mobile SDK.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'GetDecryptedAPIKey' => '

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'GetIPSet' => '

Retrieves the specified IPSet.

', 'GetLoggingConfiguration' => '

Returns the LoggingConfiguration for the specified web ACL.

', 'GetManagedRuleSet' => '

Retrieves the specified managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'GetMobileSdkRelease' => '

Retrieves information for the specified mobile SDK release, including release notes and tags.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'GetPermissionPolicy' => '

Returns the IAM policy that is attached to the specified rule group.

You must be the owner of the rule group to perform this operation.

', 'GetRateBasedStatementManagedKeys' => '

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.

The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

For a rate-based rule that you\'ve defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.

', 'GetRegexPatternSet' => '

Retrieves the specified RegexPatternSet.

', 'GetRuleGroup' => '

Retrieves the specified RuleGroup.

', 'GetSampledRequests' => '

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

', 'GetWebACL' => '

Retrieves the specified WebACL.

', 'GetWebACLForResource' => '

Retrieves the WebACL for the specified resource.

This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn\'t authorized to perform wafv2:GetWebACL on the resource, that error won\'t be included in your CloudTrail event history.

For Amazon CloudFront, don\'t use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.

', 'ListAPIKeys' => '

Retrieves a list of the API keys that you\'ve defined for the specified scope.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'ListAvailableManagedRuleGroupVersions' => '

Returns a list of the available versions for the specified managed rule group.

', 'ListAvailableManagedRuleGroups' => '

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you\'re subscribed to.

', 'ListIPSets' => '

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

', 'ListLoggingConfigurations' => '

Retrieves an array of your LoggingConfiguration objects.

', 'ListManagedRuleSets' => '

Retrieves the managed rule sets that you own.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'ListMobileSdkReleases' => '

Retrieves a list of the available releases for the mobile SDK and the specified device platform.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'ListRegexPatternSets' => '

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

', 'ListResourcesForWebACL' => '

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

For Amazon CloudFront, don\'t use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.

', 'ListRuleGroups' => '

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

', 'ListTagsForResource' => '

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'ListWebACLs' => '

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

', 'PutLoggingConfiguration' => '

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

To modify an existing logging configuration, do the following:

  1. Retrieve it by calling GetLoggingConfiguration

  2. Update its settings as needed

  3. Provide the complete logging configuration specification to this call

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

', 'PutManagedRuleSetVersions' => '

Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

', 'PutPermissionPolicy' => '

Use this to share a rule group with other accounts.

This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don\'t appear in your WAF console rule groups listing.

', 'TagResource' => '

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'UntagResource' => '

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

', 'UpdateIPSet' => '

Updates the specified IPSet.

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

To modify an IP set, do the following:

  1. Retrieve it by calling GetIPSet

  2. Update its settings as needed

  3. Provide the complete IP set specification to this call

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateManagedRuleSetVersionExpiryDate' => '

Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'UpdateRegexPatternSet' => '

Updates the specified RegexPatternSet.

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

To modify a regex pattern set, do the following:

  1. Retrieve it by calling GetRegexPatternSet

  2. Update its settings as needed

  3. Provide the complete regex pattern set specification to this call

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateRuleGroup' => '

Updates the specified RuleGroup.

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

To modify a rule group, do the following:

  1. Retrieve it by calling GetRuleGroup

  2. Update its settings as needed

  3. Provide the complete rule group specification to this call

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', 'UpdateWebACL' => '

Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

To modify a web ACL, do the following:

  1. Retrieve it by calling GetWebACL

  2. Update its settings as needed

  3. Provide the complete web ACL specification to this call

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

Temporary inconsistencies during updates

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

', ], 'shapes' => [ 'APIKey' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$APIKey' => '

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

', 'CreateAPIKeyResponse$APIKey' => '

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

', 'DeleteAPIKeyRequest$APIKey' => '

The encrypted API key that you want to delete.

', 'GetDecryptedAPIKeyRequest$APIKey' => '

The encrypted API key.

', ], ], 'APIKeySummaries' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysResponse$APIKeySummaries' => '

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

', ], ], 'APIKeySummary' => [ 'base' => '

Information for a single API key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

', 'refs' => [ 'APIKeySummaries$member' => NULL, ], ], 'APIKeyTokenDomains' => [ 'base' => NULL, 'refs' => [ 'CreateAPIKeyRequest$TokenDomains' => '

The client application domains that you want to use this API key for.

Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', ], ], 'APIKeyVersion' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$Version' => '

Internal value used by WAF to manage the key.

', ], ], 'AWSManagedRulesACFPRuleSet' => [ 'base' => '

Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesACFPRuleSet' => '

Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.

For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.

', ], ], 'AWSManagedRulesATPRuleSet' => [ 'base' => '

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesATPRuleSet' => '

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

', ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'base' => '

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

', 'refs' => [ 'ManagedRuleGroupConfig$AWSManagedRulesBotControlRuleSet' => '

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'SampledHTTPRequest$Action' => '

The action that WAF applied to the request.

', 'SampledHTTPRequest$OverriddenAction' => '

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

', ], ], 'ActionCondition' => [ 'base' => '

A single action condition for a Condition in a logging filter.

', 'refs' => [ 'Condition$ActionCondition' => '

A single action condition. This is the action setting that a log record must contain in order to meet the condition.

', ], ], 'ActionValue' => [ 'base' => NULL, 'refs' => [ 'ActionCondition$Action' => '

The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

For rule groups, this is either the configured rule action setting, or if you\'ve applied a rule action override to the rule, it\'s the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a rule action override of Count.

', ], ], 'AddressField' => [ 'base' => '

The name of a field in the request payload that contains part or all of your customer\'s primary physical address.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'AddressFields$member' => NULL, ], ], 'AddressFields' => [ 'base' => NULL, 'refs' => [ 'RequestInspectionACFP$AddressFields' => '

The names of the fields in the request payload that contain your customer\'s primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

', ], ], 'All' => [ 'base' => '

Inspect all of the elements that WAF has parsed and extracted from the web request component that you\'ve identified in your FieldToMatch specifications.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "All": {}

', 'refs' => [ 'CookieMatchPattern$All' => '

Inspect all cookies.

', 'HeaderMatchPattern$All' => '

Inspect all headers.

', 'JsonMatchPattern$All' => '

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

', ], ], 'AllQueryArguments' => [ 'base' => '

Inspect all query arguments of the web request.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "AllQueryArguments": {}

', 'refs' => [ 'FieldToMatch$AllQueryArguments' => '

Inspect all query arguments.

', ], ], 'AllowAction' => [ 'base' => '

Specifies that WAF should allow the request and optionally defines additional custom handling for the request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'DefaultAction$Allow' => '

Specifies that WAF should allow requests by default.

', 'RuleAction$Allow' => '

Instructs WAF to allow the web request.

', ], ], 'AndStatement' => [ 'base' => '

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

', 'refs' => [ 'Statement$AndStatement' => '

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

', ], ], 'AssociateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'RequestBody$key' => NULL, ], ], 'AssociationConfig' => [ 'base' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'refs' => [ 'CreateWebACLRequest$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'UpdateWebACLRequest$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', 'WebACL$AssociationConfig' => '

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', ], ], 'BlockAction' => [ 'base' => '

Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'DefaultAction$Block' => '

Specifies that WAF should block requests by default.

', 'RuleAction$Block' => '

Instructs WAF to block the web request.

', ], ], 'Body' => [ 'base' => '

Inspect the body of the web request. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

', 'refs' => [ 'FieldToMatch$Body' => '

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

For information about how to handle oversized request bodies, see the Body object configuration.

', ], ], 'BodyParsingFallbackBehavior' => [ 'base' => NULL, 'refs' => [ 'JsonBody$InvalidFallbackBehavior' => '

What WAF should do if it fails to completely parse the JSON body. The options are the following:

If you don\'t provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF parsing doesn\'t fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn\'t apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$EnableRegexInPath' => '

Allow the use of regular expressions in the registration page path and the account creation path.

', 'AWSManagedRulesATPRuleSet$EnableRegexInPath' => '

Allow the use of regular expressions in the login page path.

', 'LoggingConfiguration$ManagedByFirewallManager' => '

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

', 'ManagedProductDescriptor$IsVersioningSupported' => '

Indicates whether the rule group is versioned.

', 'ManagedProductDescriptor$IsAdvancedManagedRuleSet' => '

Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.

', 'ManagedRuleGroupSummary$VersioningSupported' => '

Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.

', 'VisibilityConfig$SampledRequestsEnabled' => '

Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

Request sampling doesn\'t provide a field redaction option, and any field redaction that you specify in your logging configuration doesn\'t affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

', 'VisibilityConfig$CloudWatchMetricsEnabled' => '

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.

For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.

', 'WebACL$ManagedByFirewallManager' => '

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

', ], ], 'ByteMatchStatement' => [ 'base' => '

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

', 'refs' => [ 'Statement$ByteMatchStatement' => '

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

', ], ], 'CapacityUnit' => [ 'base' => NULL, 'refs' => [ 'CreateRuleGroupRequest$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'DescribeManagedRuleGroupResponse$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'ManagedRuleSetVersion$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', 'RuleGroup$Capacity' => '

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', ], ], 'CaptchaAction' => [ 'base' => '

Specifies that WAF should run a CAPTCHA check against the request:

You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn\'t available for web ACL default actions.

', 'refs' => [ 'RuleAction$Captcha' => '

Instructs WAF to run a CAPTCHA check against the web request.

', ], ], 'CaptchaConfig' => [ 'base' => '

Specifies how WAF should handle CAPTCHA evaluations. This is available at the web ACL level and in each rule.

', 'refs' => [ 'CreateWebACLRequest$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', 'Rule$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations. If you don\'t specify this, WAF uses the CAPTCHA configuration that\'s defined for the web ACL.

', 'UpdateWebACLRequest$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', 'WebACL$CaptchaConfig' => '

Specifies how WAF should handle CAPTCHA evaluations for rules that don\'t have their own CaptchaConfig settings. If you don\'t specify this, WAF uses its default settings for CaptchaConfig.

', ], ], 'CaptchaResponse' => [ 'base' => '

The result from the inspection of the web request for a valid CAPTCHA token.

', 'refs' => [ 'SampledHTTPRequest$CaptchaResponse' => '

The CAPTCHA response for the request.

', ], ], 'ChallengeAction' => [ 'base' => '

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn\'t available for web ACL default actions.

', 'refs' => [ 'RuleAction$Challenge' => '

Instructs WAF to run a Challenge check against the web request.

', ], ], 'ChallengeConfig' => [ 'base' => '

Specifies how WAF should handle Challenge evaluations. This is available at the web ACL level and in each rule.

', 'refs' => [ 'CreateWebACLRequest$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', 'Rule$ChallengeConfig' => '

Specifies how WAF should handle Challenge evaluations. If you don\'t specify this, WAF uses the challenge configuration that\'s defined for the web ACL.

', 'UpdateWebACLRequest$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', 'WebACL$ChallengeConfig' => '

Specifies how WAF should handle challenge evaluations for rules that don\'t have their own ChallengeConfig settings. If you don\'t specify this, WAF uses its default settings for ChallengeConfig.

', ], ], 'ChallengeResponse' => [ 'base' => '

The result from the inspection of the web request for a valid challenge token.

', 'refs' => [ 'SampledHTTPRequest$ChallengeResponse' => '

The Challenge response for the request.

', ], ], 'CheckCapacityRequest' => [ 'base' => NULL, 'refs' => [], ], 'CheckCapacityResponse' => [ 'base' => NULL, 'refs' => [], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'SizeConstraintStatement$ComparisonOperator' => '

The operator to use to compare the request part to the size setting.

', ], ], 'Condition' => [ 'base' => '

A single match condition for a Filter.

', 'refs' => [ 'Conditions$member' => NULL, ], ], 'Conditions' => [ 'base' => NULL, 'refs' => [ 'Filter$Conditions' => '

Match conditions for the filter.

', ], ], 'ConsumedCapacity' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityResponse$Capacity' => '

The capacity required by the rules and scope.

', 'WebACL$Capacity' => '

The web ACL capacity units (WCUs) currently being used by this web ACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

', ], ], 'CookieMatchPattern' => [ 'base' => '

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

', 'refs' => [ 'Cookies$MatchPattern' => '

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

', ], ], 'CookieNames' => [ 'base' => NULL, 'refs' => [ 'CookieMatchPattern$IncludedCookies' => '

Inspect only the cookies that have a key that matches one of the strings specified here.

', 'CookieMatchPattern$ExcludedCookies' => '

Inspect only the cookies whose keys don\'t match any of the strings specified here.

', ], ], 'Cookies' => [ 'base' => '

Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

', 'refs' => [ 'FieldToMatch$Cookies' => '

Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

Only the first 8 KB (8192 bytes) of a request\'s cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

', ], ], 'CountAction' => [ 'base' => '

Specifies that WAF should count the request. Optionally defines additional custom handling for the request.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

', 'refs' => [ 'OverrideAction$Count' => '

Override the rule group evaluation result to count only.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'RuleAction$Count' => '

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

', ], ], 'Country' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Country' => '

The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'CountryCodes$member' => NULL, ], ], 'CountryCodes' => [ 'base' => NULL, 'refs' => [ 'GeoMatchStatement$CountryCodes' => '

An array of two-character country codes that you want to match against, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that\'s unlikely to be a source of traffic to your site.

', ], ], 'CreateAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationPathString' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$CreationPath' => '

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

For example, for the URL https://example.com/web/newaccount, you would provide the path /web/newaccount. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount matches the account creation paths /web/newaccount, /web/newaccount/, /web/newaccountPage, and /web/newaccount/thisPage, but doesn\'t match the path /home/web/newaccount or /website/newaccount.

', ], ], 'CustomHTTPHeader' => [ 'base' => '

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

', 'refs' => [ 'CustomHTTPHeaders$member' => NULL, ], ], 'CustomHTTPHeaderName' => [ 'base' => NULL, 'refs' => [ 'CustomHTTPHeader$Name' => '

The name of the custom header.

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

', ], ], 'CustomHTTPHeaderValue' => [ 'base' => NULL, 'refs' => [ 'CustomHTTPHeader$Value' => '

The value of the custom header.

', ], ], 'CustomHTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'CustomRequestHandling$InsertHeaders' => '

The HTTP headers to insert into the request. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'CustomResponse$ResponseHeaders' => '

The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'CustomRequestHandling' => [ 'base' => '

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for WAF to use when the rule action doesn\'t block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'refs' => [ 'AllowAction$CustomRequestHandling' => '

Defines custom handling for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'CaptchaAction$CustomRequestHandling' => '

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request\'s token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'ChallengeAction$CustomRequestHandling' => '

Defines custom handling for the web request, used when the challenge inspection determines that the request\'s token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'CountAction$CustomRequestHandling' => '

Defines custom handling for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', ], ], 'CustomResponse' => [ 'base' => '

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', 'refs' => [ 'BlockAction$CustomResponse' => '

Defines a custom response for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

', ], ], 'CustomResponseBodies' => [ 'base' => NULL, 'refs' => [ 'CreateRuleGroupRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'CreateWebACLRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'RuleGroup$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'UpdateRuleGroupRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'UpdateWebACLRequest$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', 'WebACL$CustomResponseBodies' => '

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'CustomResponseBody' => [ 'base' => '

The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey.

', 'refs' => [ 'CustomResponseBodies$value' => NULL, ], ], 'DefaultAction' => [ 'base' => '

In a WebACL, this is the action that you want WAF to perform when a web request doesn\'t match any of the rules in the WebACL. The default action must be a terminating action.

', 'refs' => [ 'CreateWebACLRequest$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', 'UpdateWebACLRequest$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', 'WebACL$DefaultAction' => '

The action to perform if none of the Rules contained in the WebACL match.

', ], ], 'DeleteAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallManagerRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFirewallManagerRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAllManagedProductsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAllManagedProductsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedProductsByVendorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedProductsByVendorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeManagedRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'DownloadUrl' => [ 'base' => NULL, 'refs' => [ 'GenerateMobileSdkReleaseUrlResponse$Url' => '

The presigned download URL for the specified SDK release.

', ], ], 'EmailField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s email.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'RequestInspectionACFP$EmailField' => '

The name of the field in the request payload that contains your customer\'s email.

How you specify this depends on the request inspection payload type.

', ], ], 'EnableMachineLearning' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesBotControlRuleSet$EnableMachineLearning' => '

Applies only to the targeted inspection level.

Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.

For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.

Default: TRUE

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Description' => '

A description of the IP set that helps with identification.

', 'CreateRegexPatternSetRequest$Description' => '

A description of the set that helps with identification.

', 'CreateRuleGroupRequest$Description' => '

A description of the rule group that helps with identification.

', 'CreateWebACLRequest$Description' => '

A description of the web ACL that helps with identification.

', 'IPSet$Description' => '

A description of the IP set that helps with identification.

', 'IPSetSummary$Description' => '

A description of the IP set that helps with identification.

', 'ManagedRuleGroupSummary$Description' => '

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.

', 'ManagedRuleSet$Description' => '

A description of the set that helps with identification.

', 'ManagedRuleSetSummary$Description' => '

A description of the set that helps with identification.

', 'RegexPatternSet$Description' => '

A description of the set that helps with identification.

', 'RegexPatternSetSummary$Description' => '

A description of the set that helps with identification.

', 'RuleGroup$Description' => '

A description of the rule group that helps with identification.

', 'RuleGroupSummary$Description' => '

A description of the rule group that helps with identification.

', 'UpdateIPSetRequest$Description' => '

A description of the IP set that helps with identification.

', 'UpdateRegexPatternSetRequest$Description' => '

A description of the set that helps with identification.

', 'UpdateRuleGroupRequest$Description' => '

A description of the rule group that helps with identification.

', 'UpdateWebACLRequest$Description' => '

A description of the web ACL that helps with identification.

', 'WebACL$Description' => '

A description of the web ACL that helps with identification.

', 'WebACLSummary$Description' => '

A description of the web ACL that helps with identification.

', ], ], 'EntityId' => [ 'base' => NULL, 'refs' => [ 'DeleteIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'DeleteWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetManagedRuleSetRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'GetRateBasedStatementManagedKeysRequest$WebACLId' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'GetWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'IPSet$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'IPSetSummary$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'ManagedRuleSet$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'ManagedRuleSetSummary$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'PutManagedRuleSetVersionsRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'RegexPatternSet$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RegexPatternSetSummary$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RuleGroup$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'RuleGroupSummary$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateIPSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Id' => '

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

', 'UpdateRegexPatternSetRequest$Id' => '

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateRuleGroupRequest$Id' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'UpdateWebACLRequest$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', 'WebACL$Id' => '

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

', 'WebACLSummary$Id' => '

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'CreateRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'CreateRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'CreateWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'CustomResponse$CustomResponseBodyKey' => '

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

', 'CustomResponseBodies$key' => NULL, 'DeleteIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'DeleteRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'DeleteRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'DeleteWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'DescribeManagedRuleGroupRequest$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ExcludedRule$Name' => '

The name of the rule whose action you want to override to Count.

', 'FirewallManagerRuleGroup$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'GetIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'GetManagedRuleSetRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'GetRateBasedStatementManagedKeysRequest$WebACLName' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'GetRateBasedStatementManagedKeysRequest$RuleGroupRuleName' => '

The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

', 'GetRateBasedStatementManagedKeysRequest$RuleName' => '

The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you\'re using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

', 'GetRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'GetRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'GetWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'IPSet$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'IPSetSummary$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'ListAvailableManagedRuleGroupVersionsRequest$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedProductDescriptor$ManagedRuleSetName' => '

The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

', 'ManagedRuleGroupStatement$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedRuleGroupSummary$Name' => '

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

', 'ManagedRuleSet$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'ManagedRuleSetSummary$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'PutManagedRuleSetVersionsRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'RegexPatternSet$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'RegexPatternSetSummary$Name' => '

The name of the data type instance. You cannot change the name after you create the instance.

', 'Rule$Name' => '

The name of the rule.

If you change the name of a Rule after you create it and you want the rule\'s metric name to reflect the change, update the metric name in the rule\'s VisibilityConfig settings. WAF doesn\'t automatically update the metric name when you update the rule name.

', 'RuleActionOverride$Name' => '

The name of the rule to override.

', 'RuleGroup$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'RuleGroupSummary$Name' => '

The name of the data type instance. You cannot change the name after you create the instance.

', 'RuleSummary$Name' => '

The name of the rule.

', 'SampledHTTPRequest$RuleNameWithinRuleGroup' => '

The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.

', 'UpdateIPSetRequest$Name' => '

The name of the IP set. You cannot change the name of an IPSet after you create it.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Name' => '

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

', 'UpdateRegexPatternSetRequest$Name' => '

The name of the set. You cannot change the name after you create the set.

', 'UpdateRuleGroupRequest$Name' => '

The name of the rule group. You cannot change the name of a rule group after you create it.

', 'UpdateWebACLRequest$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'WebACL$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', 'WebACLSummary$Name' => '

The name of the web ACL. You cannot change the name of a web ACL after you create it.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WAFAssociatedItemException$Message' => NULL, 'WAFConfigurationWarningException$Message' => NULL, 'WAFDuplicateItemException$Message' => NULL, 'WAFExpiredManagedRuleGroupVersionException$Message' => NULL, 'WAFInternalErrorException$Message' => NULL, 'WAFInvalidOperationException$Message' => NULL, 'WAFInvalidParameterException$message' => NULL, 'WAFInvalidPermissionPolicyException$Message' => NULL, 'WAFInvalidResourceException$Message' => NULL, 'WAFLimitsExceededException$Message' => NULL, 'WAFLogDestinationPermissionIssueException$Message' => NULL, 'WAFNonexistentItemException$Message' => NULL, 'WAFOptimisticLockException$Message' => NULL, 'WAFServiceLinkedRoleErrorException$message' => NULL, 'WAFSubscriptionNotFoundException$Message' => NULL, 'WAFTagOperationException$Message' => NULL, 'WAFTagOperationInternalErrorException$Message' => NULL, 'WAFUnavailableEntityException$Message' => NULL, 'WAFUnsupportedAggregateKeyTypeException$Message' => NULL, ], ], 'ErrorReason' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Reason' => '

Additional information about the exception.

', ], ], 'EvaluationWindowSec' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$EvaluationWindowSec' => '

The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.

This setting doesn\'t determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.

Default: 300 (5 minutes)

', ], ], 'ExcludedRule' => [ 'base' => '

Specifies a single rule in a rule group whose action you want to override to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', 'refs' => [ 'ExcludedRules$member' => NULL, ], ], 'ExcludedRules' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$ExcludedRules' => '

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', 'RuleGroupReferenceStatement$ExcludedRules' => '

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

', ], ], 'FailureCode' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCodeFailureCodes$member' => NULL, ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$FailureReason' => '

The reason for failure, populated when the evaluation of the token fails.

', 'ChallengeResponse$FailureReason' => '

The reason for failure, populated when the evaluation of the token fails.

', ], ], 'FailureValue' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContainsFailureStrings$member' => NULL, 'ResponseInspectionHeaderFailureValues$member' => NULL, 'ResponseInspectionJsonFailureValues$member' => NULL, ], ], 'FallbackBehavior' => [ 'base' => NULL, 'refs' => [ 'ForwardedIPConfig$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a valid IP address in the specified position.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

You can specify the following fallback behaviors:

', 'IPSetForwardedIPConfig$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a valid IP address in the specified position.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

You can specify the following fallback behaviors:

', 'JA3Fingerprint$FallbackBehavior' => '

The match status to assign to the web request if the request doesn\'t have a JA3 fingerprint.

You can specify the following fallback behaviors:

', ], ], 'FieldIdentifier' => [ 'base' => NULL, 'refs' => [ 'AddressField$Identifier' => '

The name of a single primary address field.

How you specify the address fields depends on the request inspection payload type.

', 'EmailField$Identifier' => '

The name of the email field.

How you specify this depends on the request inspection payload type.

', 'PasswordField$Identifier' => '

The name of the password field.

How you specify this depends on the request inspection payload type.

', 'PhoneNumberField$Identifier' => '

The name of a single primary phone number field.

How you specify the phone number fields depends on the request inspection payload type.

', 'ResponseInspectionJson$Identifier' => '

The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/sign-up/success" ]

', 'UsernameField$Identifier' => '

The name of the username field.

How you specify this depends on the request inspection payload type.

', ], ], 'FieldToMatch' => [ 'base' => '

Specifies a web request component to be used in a rule match statement or in a logging configuration.

', 'refs' => [ 'ByteMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'RedactedFields$member' => NULL, 'RegexMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'RegexPatternSetReferenceStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'SizeConstraintStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'SqliMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', 'XssMatchStatement$FieldToMatch' => '

The part of the web request that you want WAF to inspect.

', ], ], 'FieldToMatchData' => [ 'base' => NULL, 'refs' => [ 'HeaderNames$member' => NULL, 'RateLimitCookie$Name' => '

The name of the cookie to use.

', 'RateLimitHeader$Name' => '

The name of the header to use.

', 'RateLimitQueryArgument$Name' => '

The name of the query argument to use.

', 'SingleHeader$Name' => '

The name of the query header to inspect.

', 'SingleQueryArgument$Name' => '

The name of the query argument to inspect.

', ], ], 'Filter' => [ 'base' => '

A single logging filter, used in LoggingFilter.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'FilterBehavior' => [ 'base' => NULL, 'refs' => [ 'Filter$Behavior' => '

How to handle logs that satisfy the filter\'s conditions and requirement.

', 'LoggingFilter$DefaultBehavior' => '

Default handling for logs that don\'t match any of the specified filtering conditions.

', ], ], 'FilterRequirement' => [ 'base' => NULL, 'refs' => [ 'Filter$Requirement' => '

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

', ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'LoggingFilter$Filters' => '

The filters that you want to apply to the logs.

', ], ], 'FirewallManagerRuleGroup' => [ 'base' => '

A rule group that\'s defined for an Firewall Manager WAF policy.

', 'refs' => [ 'FirewallManagerRuleGroups$member' => NULL, ], ], 'FirewallManagerRuleGroups' => [ 'base' => NULL, 'refs' => [ 'WebACL$PreProcessFirewallManagerRuleGroups' => '

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can\'t alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

', 'WebACL$PostProcessFirewallManagerRuleGroups' => '

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can\'t alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

', ], ], 'FirewallManagerStatement' => [ 'base' => '

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.

', 'refs' => [ 'FirewallManagerRuleGroup$FirewallManagerStatement' => '

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

', ], ], 'ForwardedIPConfig' => [ 'base' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

', 'refs' => [ 'GeoMatchStatement$ForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', 'RateBasedStatement$ForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This is required if you specify a forwarded IP in the rule\'s aggregate key settings.

', ], ], 'ForwardedIPHeaderName' => [ 'base' => NULL, 'refs' => [ 'ForwardedIPConfig$HeaderName' => '

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', 'IPSetForwardedIPConfig$HeaderName' => '

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', ], ], 'ForwardedIPPosition' => [ 'base' => NULL, 'refs' => [ 'IPSetForwardedIPConfig$Position' => '

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

', ], ], 'GenerateMobileSdkReleaseUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GenerateMobileSdkReleaseUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GeoMatchStatement' => [ 'base' => '

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.

For additional details, see Geographic match rule statement in the WAF Developer Guide.

', 'refs' => [ 'Statement$GeoMatchStatement' => '

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>.

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>.

For additional details, see Geographic match rule statement in the WAF Developer Guide.

', ], ], 'GetDecryptedAPIKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDecryptedAPIKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetManagedRuleSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetManagedRuleSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileSdkReleaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileSdkReleaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRateBasedStatementManagedKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRateBasedStatementManagedKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSampledRequestsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSampledRequestsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'HTTPHeader' => [ 'base' => '

Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.

', 'refs' => [ 'HTTPHeaders$member' => NULL, ], ], 'HTTPHeaders' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Headers' => '

A complex type that contains the name and value for each header in the sampled web request.

', 'SampledHTTPRequest$RequestHeadersInserted' => '

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

', ], ], 'HTTPMethod' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$Method' => '

The HTTP method specified in the sampled web request.

', ], ], 'HTTPRequest' => [ 'base' => '

Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.

', 'refs' => [ 'SampledHTTPRequest$Request' => '

A complex type that contains detailed information about the request.

', ], ], 'HTTPVersion' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$HTTPVersion' => '

The HTTP version specified in the sampled web request, for example, HTTP/1.1.

', ], ], 'HeaderMatchPattern' => [ 'base' => '

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

', 'refs' => [ 'Headers$MatchPattern' => '

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

', ], ], 'HeaderName' => [ 'base' => NULL, 'refs' => [ 'HTTPHeader$Name' => '

The name of the HTTP header.

', ], ], 'HeaderNames' => [ 'base' => NULL, 'refs' => [ 'HeaderMatchPattern$IncludedHeaders' => '

Inspect only the headers that have a key that matches one of the strings specified here.

', 'HeaderMatchPattern$ExcludedHeaders' => '

Inspect only the headers whose keys don\'t match any of the strings specified here.

', ], ], 'HeaderOrder' => [ 'base' => '

Inspect a string containing the list of the request\'s header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

', 'refs' => [ 'FieldToMatch$HeaderOrder' => '

Inspect a string containing the list of the request\'s header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

', ], ], 'HeaderValue' => [ 'base' => NULL, 'refs' => [ 'HTTPHeader$Value' => '

The value of the HTTP header.

', ], ], 'Headers' => [ 'base' => '

Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

', 'refs' => [ 'FieldToMatch$Headers' => '

Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

Only the first 8 KB (8192 bytes) of a request\'s headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

', ], ], 'IPAddress' => [ 'base' => NULL, 'refs' => [ 'IPAddresses$member' => NULL, ], ], 'IPAddressVersion' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', 'IPSet$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', 'RateBasedStatementManagedKeysIPSet$IPAddressVersion' => '

The version of the IP addresses, either IPV4 or IPV6.

', ], ], 'IPAddresses' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', 'IPSet$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', 'RateBasedStatementManagedKeysIPSet$Addresses' => '

The IP addresses that are currently blocked.

', 'UpdateIPSetRequest$Addresses' => '

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

', ], ], 'IPSet' => [ 'base' => '

Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

', 'refs' => [ 'GetIPSetResponse$IPSet' => '

', ], ], 'IPSetForwardedIPConfig' => [ 'base' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

', 'refs' => [ 'IPSetReferenceStatement$IPSetForwardedIPConfig' => '

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that\'s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn\'t present in the request, WAF doesn\'t apply the rule to the web request at all.

', ], ], 'IPSetReferenceStatement' => [ 'base' => '

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', 'refs' => [ 'Statement$IPSetReferenceStatement' => '

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', ], ], 'IPSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListIPSetsResponse$IPSets' => '

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'IPSetSummary' => [ 'base' => '

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

', 'refs' => [ 'CreateIPSetResponse$Summary' => '

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

', 'IPSetSummaries$member' => NULL, ], ], 'IPString' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$ClientIP' => '

The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

', ], ], 'ImmunityTimeProperty' => [ 'base' => '

Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

', 'refs' => [ 'CaptchaConfig$ImmunityTimeProperty' => '

Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.

', 'ChallengeConfig$ImmunityTimeProperty' => '

Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.

', ], ], 'InspectionLevel' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesBotControlRuleSet$InspectionLevel' => '

The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.

', ], ], 'JA3Fingerprint' => [ 'base' => '

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request\'s JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client\'s TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.

You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.

Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

', 'refs' => [ 'FieldToMatch$JA3Fingerprint' => '

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request\'s JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client\'s TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY.

You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.

Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

', ], ], 'JsonBody' => [ 'base' => '

Inspect the body of the web request as JSON. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule\'s inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.

Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }

For additional information about this request component option, see JSON body in the WAF Developer Guide.

', 'refs' => [ 'FieldToMatch$JsonBody' => '

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

For information about how to handle oversized request bodies, see the JsonBody object configuration.

', ], ], 'JsonMatchPattern' => [ 'base' => '

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

', 'refs' => [ 'JsonBody$MatchPattern' => '

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

', ], ], 'JsonMatchScope' => [ 'base' => NULL, 'refs' => [ 'JsonBody$MatchScope' => '

The parts of the JSON to match against using the MatchPattern. If you specify ALL, WAF matches against keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', ], ], 'JsonPointerPath' => [ 'base' => NULL, 'refs' => [ 'JsonPointerPaths$member' => NULL, ], ], 'JsonPointerPaths' => [ 'base' => NULL, 'refs' => [ 'JsonMatchPattern$IncludedPaths' => '

Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don\'t use this option to include all paths. Instead, use the All setting.

', ], ], 'Label' => [ 'base' => '

A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest.

', 'refs' => [ 'Labels$member' => NULL, ], ], 'LabelMatchKey' => [ 'base' => NULL, 'refs' => [ 'LabelMatchStatement$Key' => '

The string to match against. The setting you provide for this depends on the match statement\'s Scope setting:

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

', ], ], 'LabelMatchScope' => [ 'base' => NULL, 'refs' => [ 'LabelMatchStatement$Scope' => '

Specify whether you want to match using the label name or just the namespace.

', ], ], 'LabelMatchStatement' => [ 'base' => '

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

', 'refs' => [ 'Statement$LabelMatchStatement' => '

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

', ], ], 'LabelName' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$LabelNamespace' => '

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

', 'Label$Name' => '

The label string.

', 'LabelNameCondition$LabelName' => '

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

', 'LabelSummary$Name' => '

An individual label specification.

', 'ManagedRuleSet$LabelNamespace' => '

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

', 'ManagedRuleSetSummary$LabelNamespace' => '

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

', 'RuleGroup$LabelNamespace' => '

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

', 'WebACL$LabelNamespace' => '

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

', ], ], 'LabelNameCondition' => [ 'base' => '

A single label name condition for a Condition in a logging filter.

', 'refs' => [ 'Condition$LabelNameCondition' => '

A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

', ], ], 'LabelNamespace' => [ 'base' => NULL, 'refs' => [ 'RateLimitLabelNamespace$Namespace' => '

The namespace to use for aggregation.

', ], ], 'LabelSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$AvailableLabels' => '

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

', 'DescribeManagedRuleGroupResponse$ConsumedLabels' => '

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

', 'RuleGroup$AvailableLabels' => '

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

', 'RuleGroup$ConsumedLabels' => '

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

', ], ], 'LabelSummary' => [ 'base' => '

List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:

', 'refs' => [ 'LabelSummaries$member' => NULL, ], ], 'Labels' => [ 'base' => NULL, 'refs' => [ 'Rule$RuleLabels' => '

Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule\'s rule group or web ACL defines the label namespace.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

', 'SampledHTTPRequest$Labels' => '

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule\'s rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

', ], ], 'ListAPIKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAPIKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagedRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIPSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIPSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLoggingConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLoggingConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedRuleSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListManagedRuleSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxItems' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsRequest$MaxItems' => '

The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

', ], ], 'ListMobileSdkReleasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileSdkReleasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegexPatternSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRegexPatternSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRuleGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRuleGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWebACLsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWebACLsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LockToken' => [ 'base' => NULL, 'refs' => [ 'DeleteFirewallManagerRuleGroupsRequest$WebACLLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteFirewallManagerRuleGroupsResponse$NextWebACLLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteIPSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteRegexPatternSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteRuleGroupRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'DeleteWebACLRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetIPSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetManagedRuleSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetRegexPatternSetResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetRuleGroupResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'GetWebACLResponse$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'IPSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'ManagedRuleSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'PutManagedRuleSetVersionsRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'PutManagedRuleSetVersionsResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'RegexPatternSetSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'RuleGroupSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateIPSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateIPSetResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateManagedRuleSetVersionExpiryDateResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRegexPatternSetRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRegexPatternSetResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateRuleGroupRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateRuleGroupResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'UpdateWebACLRequest$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', 'UpdateWebACLResponse$NextLockToken' => '

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

', 'WebACLSummary$LockToken' => '

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

', ], ], 'LogDestinationConfigs' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$LogDestinationConfigs' => '

The logging destination configuration that you want to associate with the web ACL.

You can associate one logging destination to a web ACL.

', ], ], 'LogScope' => [ 'base' => NULL, 'refs' => [ 'DeleteLoggingConfigurationRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'GetLoggingConfigurationRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'ListLoggingConfigurationsRequest$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', 'LoggingConfiguration$LogScope' => '

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

', ], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'DeleteLoggingConfigurationRequest$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', 'GetLoggingConfigurationRequest$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', 'LoggingConfiguration$LogType' => '

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

', ], ], 'LoggingConfiguration' => [ 'base' => '

Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

', 'refs' => [ 'GetLoggingConfigurationResponse$LoggingConfiguration' => '

The LoggingConfiguration for the specified web ACL.

', 'LoggingConfigurations$member' => NULL, 'PutLoggingConfigurationRequest$LoggingConfiguration' => '

', 'PutLoggingConfigurationResponse$LoggingConfiguration' => '

', ], ], 'LoggingConfigurations' => [ 'base' => NULL, 'refs' => [ 'ListLoggingConfigurationsResponse$LoggingConfigurations' => '

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

', ], ], 'LoggingFilter' => [ 'base' => '

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL\'s LoggingConfiguration.

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

', 'refs' => [ 'LoggingConfiguration$LoggingFilter' => '

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

', ], ], 'LoginPathString' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupConfig$LoginPath' => '

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

', ], ], 'ManagedProductDescriptor' => [ 'base' => '

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

', 'refs' => [ 'ManagedProductDescriptors$member' => NULL, ], ], 'ManagedProductDescriptors' => [ 'base' => NULL, 'refs' => [ 'DescribeAllManagedProductsResponse$ManagedProducts' => '

High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

', 'DescribeManagedProductsByVendorResponse$ManagedProducts' => '

High-level information for the managed rule groups owned by the specified vendor.

', ], ], 'ManagedRuleGroupConfig' => [ 'base' => '

Additional information that\'s used by a managed rule group. Many managed rule groups don\'t require this.

The rule groups used for intelligent threat mitigation require additional configuration:

For example specifications, see the examples section of CreateWebACL.

', 'refs' => [ 'ManagedRuleGroupConfigs$member' => NULL, ], ], 'ManagedRuleGroupConfigs' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$ManagedRuleGroupConfigs' => '

Additional information that\'s used by a managed rule group. Many managed rule groups don\'t require this.

The rule groups used for intelligent threat mitigation require additional configuration:

', ], ], 'ManagedRuleGroupStatement' => [ 'base' => '

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

', 'refs' => [ 'FirewallManagerStatement$ManagedRuleGroupStatement' => '

A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

', 'Statement$ManagedRuleGroupStatement' => '

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

', ], ], 'ManagedRuleGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagedRuleGroupsResponse$ManagedRuleGroups' => '

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleGroupSummary' => [ 'base' => '

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.

', 'refs' => [ 'ManagedRuleGroupSummaries$member' => NULL, ], ], 'ManagedRuleGroupVersion' => [ 'base' => '

Describes a single version of a managed rule group.

', 'refs' => [ 'ManagedRuleGroupVersions$member' => NULL, ], ], 'ManagedRuleGroupVersions' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagedRuleGroupVersionsResponse$Versions' => '

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleSet' => [ 'base' => '

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'GetManagedRuleSetResponse$ManagedRuleSet' => '

The managed rule set that you requested.

', ], ], 'ManagedRuleSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListManagedRuleSetsResponse$ManagedRuleSets' => '

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ManagedRuleSetSummary' => [ 'base' => '

High-level information for a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'ManagedRuleSetSummaries$member' => NULL, ], ], 'ManagedRuleSetVersion' => [ 'base' => '

Information for a single version of a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'PublishedVersions$value' => NULL, ], ], 'MapMatchScope' => [ 'base' => NULL, 'refs' => [ 'Cookies$MatchScope' => '

The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', 'Headers$MatchScope' => '

The parts of the headers to match with the rule inspection criteria. If you specify ALL, WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

', ], ], 'Method' => [ 'base' => '

Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "Method": {}

', 'refs' => [ 'FieldToMatch$Method' => '

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsRequest$RuleMetricName' => '

The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.

', 'VisibilityConfig$MetricName' => '

A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can\'t contain whitespace or metric names that are reserved for WAF, for example All and Default_Action.

', ], ], 'MobileSdkRelease' => [ 'base' => '

Information for a release of the mobile SDK, including release notes and tags.

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

', 'refs' => [ 'GetMobileSdkReleaseResponse$MobileSdkRelease' => '

Information for a specified SDK release, including release notes and tags.

', ], ], 'NextMarker' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAPIKeysResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupVersionsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupVersionsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListAvailableManagedRuleGroupsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListIPSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListIPSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListLoggingConfigurationsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListLoggingConfigurationsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListManagedRuleSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListManagedRuleSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListMobileSdkReleasesRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListMobileSdkReleasesResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRegexPatternSetsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRegexPatternSetsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRuleGroupsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListRuleGroupsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListTagsForResourceRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListTagsForResourceResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListWebACLsRequest$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', 'ListWebACLsResponse$NextMarker' => '

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

', ], ], 'NoneAction' => [ 'base' => '

Specifies that WAF should do nothing. This is used for the OverrideAction setting on a Rule when the rule uses a rule group reference statement.

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

JSON specification: "None": {}

', 'refs' => [ 'OverrideAction$None' => '

Don\'t override the rule group evaluation result. This is the most common setting.

', ], ], 'NotStatement' => [ 'base' => '

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

', 'refs' => [ 'Statement$NotStatement' => '

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

', ], ], 'OrStatement' => [ 'base' => '

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

', 'refs' => [ 'Statement$OrStatement' => '

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

', ], ], 'OutputUrl' => [ 'base' => NULL, 'refs' => [ 'GetWebACLResponse$ApplicationIntegrationURL' => '

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

', 'ListAPIKeysResponse$ApplicationIntegrationURL' => '

The CAPTCHA application integration URL, for use in your JavaScript implementation.

', ], ], 'OverrideAction' => [ 'base' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'refs' => [ 'FirewallManagerRuleGroup$OverrideAction' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', 'Rule$OverrideAction' => '

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

', ], ], 'OversizeHandling' => [ 'base' => NULL, 'refs' => [ 'Body$OversizeHandling' => '

What WAF should do if the body is larger than WAF can inspect.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

The options for oversize handling are the following:

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

', 'Cookies$OversizeHandling' => '

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.

The options for oversize handling are the following:

', 'HeaderOrder$OversizeHandling' => '

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

', 'Headers$OversizeHandling' => '

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.

The options for oversize handling are the following:

', 'JsonBody$OversizeHandling' => '

What WAF should do if the body is larger than WAF can inspect.

WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

The options for oversize handling are the following:

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

', ], ], 'PaginationLimit' => [ 'base' => NULL, 'refs' => [ 'ListAPIKeysRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListAvailableManagedRuleGroupVersionsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListAvailableManagedRuleGroupsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListIPSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListLoggingConfigurationsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListManagedRuleSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListMobileSdkReleasesRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListRegexPatternSetsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListRuleGroupsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListTagsForResourceRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', 'ListWebACLsRequest$Limit' => '

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

', ], ], 'ParameterExceptionField' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Field' => '

The settings where the invalid parameter was found.

', ], ], 'ParameterExceptionParameter' => [ 'base' => NULL, 'refs' => [ 'WAFInvalidParameterException$Parameter' => '

The invalid parameter that resulted in the exception.

', ], ], 'PasswordField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s password.

This data type is used in the RequestInspection and RequestInspectionACFP data types.

', 'refs' => [ 'ManagedRuleGroupConfig$PasswordField' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$PasswordField' => '

The name of the field in the request payload that contains your customer\'s password.

How you specify this depends on the request inspection payload type.

', 'RequestInspectionACFP$PasswordField' => '

The name of the field in the request payload that contains your customer\'s password.

How you specify this depends on the request inspection payload type.

', ], ], 'PayloadType' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupConfig$PayloadType' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$PayloadType' => '

The payload type for your login endpoint, either JSON or form encoded.

', 'RequestInspectionACFP$PayloadType' => '

The payload type for your account creation endpoint, either JSON or form encoded.

', ], ], 'PhoneNumberField' => [ 'base' => '

The name of a field in the request payload that contains part or all of your customer\'s primary phone number.

This data type is used in the RequestInspectionACFP data type.

', 'refs' => [ 'PhoneNumberFields$member' => NULL, ], ], 'PhoneNumberFields' => [ 'base' => NULL, 'refs' => [ 'RequestInspectionACFP$PhoneNumberFields' => '

The names of the fields in the request payload that contain your customer\'s primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

', ], ], 'Platform' => [ 'base' => NULL, 'refs' => [ 'GenerateMobileSdkReleaseUrlRequest$Platform' => '

The device platform.

', 'GetMobileSdkReleaseRequest$Platform' => '

The device platform.

', 'ListMobileSdkReleasesRequest$Platform' => '

The device platform to retrieve the list for.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetPermissionPolicyResponse$Policy' => '

The IAM policy that is attached to the specified rule group.

', 'PutPermissionPolicyRequest$Policy' => '

The policy to attach to the specified rule group.

The policy specifications must conform to the following:

For more information, see IAM Policies.

', ], ], 'PopulationSize' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsResponse$PopulationSize' => '

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.

', ], ], 'PositionalConstraint' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$PositionalConstraint' => '

The area within the portion of the web request that you want WAF to search for SearchString. Valid values include the following:

CONTAINS

The specified part of the web request must include the value of SearchString, but the location doesn\'t matter.

CONTAINS_WORD

The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

EXACTLY

The value of the specified part of the web request must exactly match the value of SearchString.

STARTS_WITH

The value of SearchString must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of SearchString must appear at the end of the specified part of the web request.

', ], ], 'ProductDescription' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductDescription' => '

A short description of the managed rule group.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductId' => '

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

', ], ], 'ProductLink' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductLink' => '

For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

', ], ], 'ProductTitle' => [ 'base' => NULL, 'refs' => [ 'ManagedProductDescriptor$ProductTitle' => '

The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

', ], ], 'PublishedVersions' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleSet$PublishedVersions' => '

The versions of this managed rule set that are available for use by customers.

', ], ], 'PutLoggingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutLoggingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutManagedRuleSetVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutManagedRuleSetVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutPermissionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPermissionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryString' => [ 'base' => '

Inspect the query string of the web request. This is the part of a URL that appears after a ? character, if any.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "QueryString": {}

', 'refs' => [ 'FieldToMatch$QueryString' => '

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

', ], ], 'RateBasedStatement' => [ 'base' => '

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

If you change any of these settings in a rule that\'s currently in use, the change resets the rule\'s rate limiting counts. This can pause the rule\'s rate limiting activities for up to a minute.

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

The rule would create different aggregation instances according to your aggregation criteria, for example:

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

', 'refs' => [ 'Statement$RateBasedStatement' => '

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

If you change any of these settings in a rule that\'s currently in use, the change resets the rule\'s rate limiting counts. This can pause the rule\'s rate limiting activities for up to a minute.

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

The rule would create different aggregation instances according to your aggregation criteria, for example:

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

', ], ], 'RateBasedStatementAggregateKeyType' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$AggregateKeyType' => '

Setting that indicates how to aggregate the request counts.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

', ], ], 'RateBasedStatementCustomKey' => [ 'base' => '

Specifies a single custom aggregate key for a rate-base rule.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

', 'refs' => [ 'RateBasedStatementCustomKeys$member' => NULL, ], ], 'RateBasedStatementCustomKeys' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$CustomKeys' => '

Specifies the aggregate keys to use in a rate-base rule.

', ], ], 'RateBasedStatementManagedKeysIPSet' => [ 'base' => '

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

A rate-based rule applies its rule action to requests from IP addresses that are in the rule\'s managed keys list and that match the rule\'s scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

', 'refs' => [ 'GetRateBasedStatementManagedKeysResponse$ManagedKeysIPV4' => '

The keys that are of Internet Protocol version 4 (IPv4).

', 'GetRateBasedStatementManagedKeysResponse$ManagedKeysIPV6' => '

The keys that are of Internet Protocol version 6 (IPv6).

', ], ], 'RateLimit' => [ 'base' => NULL, 'refs' => [ 'RateBasedStatement$Limit' => '

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

Examples:

', ], ], 'RateLimitCookie' => [ 'base' => '

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$Cookie' => '

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitForwardedIP' => [ 'base' => '

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement\'s AggregateKeyType.

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn\'t explicitly use this data type.

JSON specification: "ForwardedIP": {}

When you use this specification, you must also configure the forwarded IP address in the rate-based statement\'s ForwardedIPConfig.

', 'refs' => [ 'RateBasedStatementCustomKey$ForwardedIP' => '

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement\'s AggregateKeyType.

With this option, you must specify the header to use in the rate-based rule\'s ForwardedIPConfig property.

', ], ], 'RateLimitHTTPMethod' => [ 'base' => '

Specifies the request\'s HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

JSON specification: "RateLimitHTTPMethod": {}

', 'refs' => [ 'RateBasedStatementCustomKey$HTTPMethod' => '

Use the request\'s HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

', ], ], 'RateLimitHeader' => [ 'base' => '

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$Header' => '

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitIP' => [ 'base' => '

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement\'s AggregateKeyType, specify IP.

JSON specification: "RateLimitIP": {}

', 'refs' => [ 'RateBasedStatementCustomKey$IP' => '

Use the request\'s originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement\'s AggregateKeyType.

', ], ], 'RateLimitLabelNamespace' => [ 'base' => '

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

', 'refs' => [ 'RateBasedStatementCustomKey$LabelNamespace' => '

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

', ], ], 'RateLimitQueryArgument' => [ 'base' => '

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$QueryArgument' => '

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

', ], ], 'RateLimitQueryString' => [ 'base' => '

Specifies the request\'s query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$QueryString' => '

Use the request\'s query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

', ], ], 'RateLimitUriPath' => [ 'base' => '

Specifies the request\'s URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

', 'refs' => [ 'RateBasedStatementCustomKey$UriPath' => '

Use the request\'s URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

', ], ], 'RedactedFields' => [ 'base' => NULL, 'refs' => [ 'LoggingConfiguration$RedactedFields' => '

The parts of the request that you want to keep out of the logs.

For example, if you redact the SingleHeader field, the HEADER field in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting.

Redaction applies only to the component that\'s specified in the rule\'s FieldToMatch setting, so the SingleHeader redaction doesn\'t apply to rules that use the Headers FieldToMatch.

You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, and Method.

This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.

', ], ], 'Regex' => [ 'base' => '

A single regular expression. This is used in a RegexPatternSet.

', 'refs' => [ 'RegularExpressionList$member' => NULL, ], ], 'RegexMatchStatement' => [ 'base' => '

A rule statement used to search web request components for a match against a single regular expression.

', 'refs' => [ 'Statement$RegexMatchStatement' => '

A rule statement used to search web request components for a match against a single regular expression.

', ], ], 'RegexPatternSet' => [ 'base' => '

Contains one or more regular expressions.

WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

', 'refs' => [ 'GetRegexPatternSetResponse$RegexPatternSet' => '

', ], ], 'RegexPatternSetReferenceStatement' => [ 'base' => '

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', 'refs' => [ 'Statement$RegexPatternSetReferenceStatement' => '

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

', ], ], 'RegexPatternSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListRegexPatternSetsResponse$RegexPatternSets' => '

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

', ], ], 'RegexPatternSetSummary' => [ 'base' => '

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

', 'refs' => [ 'CreateRegexPatternSetResponse$Summary' => '

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

', 'RegexPatternSetSummaries$member' => NULL, ], ], 'RegexPatternString' => [ 'base' => NULL, 'refs' => [ 'Regex$RegexString' => '

The string representing the regular expression.

', 'RegexMatchStatement$RegexString' => '

The string representing the regular expression.

', ], ], 'RegistrationPagePathString' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesACFPRuleSet$RegistrationPagePath' => '

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

This page must accept GET text/html requests.

For example, for the URL https://example.com/web/registration, you would provide the path /web/registration. Registration page paths that start with the path that you provide are considered a match. For example /web/registration matches the registration paths /web/registration, /web/registration/, /web/registrationPage, and /web/registration/thisPage, but doesn\'t match the path /home/web/registration or /website/registration.

', ], ], 'RegularExpressionList' => [ 'base' => NULL, 'refs' => [ 'CreateRegexPatternSetRequest$RegularExpressionList' => '

Array of regular expression strings.

', 'RegexPatternSet$RegularExpressionList' => '

The regular expression patterns in the set.

', 'UpdateRegexPatternSetRequest$RegularExpressionList' => '

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'MobileSdkRelease$ReleaseNotes' => '

Notes describing the release.

', ], ], 'ReleaseSummaries' => [ 'base' => NULL, 'refs' => [ 'ListMobileSdkReleasesResponse$ReleaseSummaries' => '

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

', ], ], 'ReleaseSummary' => [ 'base' => '

High level information for an SDK release.

', 'refs' => [ 'ReleaseSummaries$member' => NULL, ], ], 'RequestBody' => [ 'base' => NULL, 'refs' => [ 'AssociationConfig$RequestBody' => '

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

', ], ], 'RequestBodyAssociatedResourceTypeConfig' => [ 'base' => '

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

This is used in the AssociationConfig of the web ACL.

', 'refs' => [ 'RequestBody$value' => NULL, ], ], 'RequestInspection' => [ 'base' => '

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

', 'refs' => [ 'AWSManagedRulesATPRuleSet$RequestInspection' => '

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

', ], ], 'RequestInspectionACFP' => [ 'base' => '

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.

', 'refs' => [ 'AWSManagedRulesACFPRuleSet$RequestInspection' => '

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AssociateWebACLRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

', 'AssociateWebACLRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

The ARN must be in one of the following formats:

', 'DeleteFirewallManagerRuleGroupsRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL.

', 'DeleteLoggingConfigurationRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

', 'DeletePermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.

You must be the owner of the rule group to perform this operation.

', 'DescribeManagedRuleGroupResponse$SnsTopicArn' => '

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that\'s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

', 'DisassociateWebACLRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

The ARN must be in one of the following formats:

', 'GetLoggingConfigurationRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

', 'GetPermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.

', 'GetRuleGroupRequest$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'GetSampledRequestsRequest$WebAclArn' => '

The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

', 'GetWebACLForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

The ARN must be in one of the following formats:

', 'IPSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'IPSetReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the IPSet that this statement references.

', 'IPSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ListResourcesForWebACLRequest$WebACLArn' => '

The Amazon Resource Name (ARN) of the web ACL.

', 'ListTagsForResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'LogDestinationConfigs$member' => NULL, 'LoggingConfiguration$ResourceArn' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

', 'ManagedProductDescriptor$SnsTopicArn' => '

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that\'s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

', 'ManagedRuleSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ManagedRuleSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ManagedRuleSetVersion$AssociatedRuleGroupArn' => '

The Amazon Resource Name (ARN) of the vendor rule group that\'s used to define the published version of your managed rule group.

', 'PutPermissionPolicyRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

', 'RegexPatternSet$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RegexPatternSetReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

', 'RegexPatternSetSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'ResourceArns$member' => NULL, 'RuleGroup$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RuleGroupReferenceStatement$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'RuleGroupSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', 'TagInfoForResource$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'TagResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceARN' => '

The Amazon Resource Name (ARN) of the resource.

', 'VersionToPublish$AssociatedRuleGroupArn' => '

The Amazon Resource Name (ARN) of the vendor\'s rule group that\'s used in the published managed rule group version.

', 'WebACL$ARN' => '

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

', 'WebACLSummary$ARN' => '

The Amazon Resource Name (ARN) of the entity.

', ], ], 'ResourceArns' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForWebACLResponse$ResourceArns' => '

The array of Amazon Resource Names (ARNs) of the associated resources.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForWebACLRequest$ResourceType' => '

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

If you don\'t provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.

Default: APPLICATION_LOAD_BALANCER

', ], ], 'ResponseCode' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$ResponseCode' => '

The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.

', 'ChallengeResponse$ResponseCode' => '

The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.

', ], ], 'ResponseContent' => [ 'base' => NULL, 'refs' => [ 'CustomResponseBody$Content' => '

The payload of the custom response.

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

', ], ], 'ResponseContentType' => [ 'base' => NULL, 'refs' => [ 'CustomResponseBody$ContentType' => '

The type of content in the payload that you are defining in the Content string.

', ], ], 'ResponseInspection' => [ 'base' => '

The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.

This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.

Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can\'t configure more than one component for inspection. If you don\'t configure any of the response inspection options, response inspection is disabled.

', 'refs' => [ 'AWSManagedRulesACFPRuleSet$ResponseInspection' => '

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.

', 'AWSManagedRulesATPRuleSet$ResponseInspection' => '

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

', ], ], 'ResponseInspectionBodyContains' => [ 'base' => '

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$BodyContains' => '

Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

', ], ], 'ResponseInspectionBodyContainsFailureStrings' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContains$FailureStrings' => '

Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

JSON example: "FailureStrings": [ "Request failed" ]

', ], ], 'ResponseInspectionBodyContainsSuccessStrings' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContains$SuccessStrings' => '

Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

JSON examples: "SuccessStrings": [ "Login successful" ] and "SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]

', ], ], 'ResponseInspectionHeader' => [ 'base' => '

Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$Header' => '

Configures inspection of the response header for success and failure indicators.

', ], ], 'ResponseInspectionHeaderFailureValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$FailureValues' => '

Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]

', ], ], 'ResponseInspectionHeaderName' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$Name' => '

The name of the header to match against. The name must be an exact match, including case.

JSON example: "Name": [ "RequestResult" ]

', ], ], 'ResponseInspectionHeaderSuccessValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionHeader$SuccessValues' => '

Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]

', ], ], 'ResponseInspectionJson' => [ 'base' => '

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$Json' => '

Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

', ], ], 'ResponseInspectionJsonFailureValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionJson$FailureValues' => '

Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "FailureValues": [ "False", "Failed" ]

', ], ], 'ResponseInspectionJsonSuccessValues' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionJson$SuccessValues' => '

Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "SuccessValues": [ "True", "Succeeded" ]

', ], ], 'ResponseInspectionStatusCode' => [ 'base' => '

Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

', 'refs' => [ 'ResponseInspection$StatusCode' => '

Configures inspection of the response status code for success and failure indicators.

', ], ], 'ResponseInspectionStatusCodeFailureCodes' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCode$FailureCodes' => '

Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

JSON example: "FailureCodes": [ 400, 404 ]

', ], ], 'ResponseInspectionStatusCodeSuccessCodes' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCode$SuccessCodes' => '

Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

JSON example: "SuccessCodes": [ 200, 201 ]

', ], ], 'ResponseStatusCode' => [ 'base' => NULL, 'refs' => [ 'CustomResponse$ResponseCode' => '

The HTTP status code to return to the client.

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

', 'SampledHTTPRequest$ResponseCodeSent' => '

The response code that was sent for the request.

', ], ], 'Rule' => [ 'base' => '

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'RuleAction' => [ 'base' => '

The action that WAF should take on a web request when it matches a rule\'s statement. Settings at the web ACL level can override the rule action setting.

', 'refs' => [ 'Rule$Action' => '

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

You must specify either this Action setting or the rule OverrideAction setting, but not both:

', 'RuleActionOverride$ActionToUse' => '

The override action to use, in place of the configured action of the rule in the rule group.

', 'RuleSummary$Action' => '

The action that WAF should take on a web request when it matches a rule\'s statement. Settings at the web ACL level can override the rule action setting.

', ], ], 'RuleActionOverride' => [ 'base' => '

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', 'refs' => [ 'RuleActionOverrides$member' => NULL, ], ], 'RuleActionOverrides' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleGroupStatement$RuleActionOverrides' => '

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', 'RuleGroupReferenceStatement$RuleActionOverrides' => '

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

', ], ], 'RuleGroup' => [ 'base' => '

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

', 'refs' => [ 'GetRuleGroupResponse$RuleGroup' => '

', ], ], 'RuleGroupReferenceStatement' => [ 'base' => '

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

', 'refs' => [ 'FirewallManagerStatement$RuleGroupReferenceStatement' => '

A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

', 'Statement$RuleGroupReferenceStatement' => '

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

', ], ], 'RuleGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListRuleGroupsResponse$RuleGroups' => '

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

', ], ], 'RuleGroupSummary' => [ 'base' => '

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'refs' => [ 'CreateRuleGroupResponse$Summary' => '

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'RuleGroupSummaries$member' => NULL, ], ], 'RulePriority' => [ 'base' => NULL, 'refs' => [ 'FirewallManagerRuleGroup$Priority' => '

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don\'t need to be consecutive, but they must all be different.

', 'Rule$Priority' => '

If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don\'t need to be consecutive, but they must all be different.

', ], ], 'RuleSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupResponse$Rules' => '

', ], ], 'RuleSummary' => [ 'base' => '

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

', 'refs' => [ 'RuleSummaries$member' => NULL, ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityRequest$Rules' => '

An array of Rule that you\'re configuring to use in a rule group or web ACL.

', 'CreateRuleGroupRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'CreateWebACLRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'RuleGroup$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'UpdateRuleGroupRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'UpdateWebACLRequest$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', 'WebACL$Rules' => '

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

', ], ], 'SampleWeight' => [ 'base' => NULL, 'refs' => [ 'SampledHTTPRequest$Weight' => '

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

', ], ], 'SampledHTTPRequest' => [ 'base' => '

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.

', 'refs' => [ 'SampledHTTPRequests$member' => NULL, ], ], 'SampledHTTPRequests' => [ 'base' => NULL, 'refs' => [ 'GetSampledRequestsResponse$SampledRequests' => '

A complex type that contains detailed information about each of the requests in the sample.

', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'CheckCapacityRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'CreateWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DeleteWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeAllManagedProductsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeManagedProductsByVendorRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'DescribeManagedRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetDecryptedAPIKeyRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetManagedRuleSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRateBasedStatementManagedKeysRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetSampledRequestsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'GetWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAPIKeysRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAvailableManagedRuleGroupVersionsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListAvailableManagedRuleGroupsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListIPSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListLoggingConfigurationsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListManagedRuleSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListRegexPatternSetsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListRuleGroupsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'ListWebACLsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'PutManagedRuleSetVersionsRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateIPSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateManagedRuleSetVersionExpiryDateRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateRegexPatternSetRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateRuleGroupRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', 'UpdateWebACLRequest$Scope' => '

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

', ], ], 'SearchString' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$SearchString' => '

A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.

Valid values depend on the component that you specify for inspection in FieldToMatch:

If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

If you\'re using the WAF API

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.

For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.

If you\'re using the CLI or one of the Amazon Web Services SDKs

The value that you want WAF to search for. The SDK automatically base64 encodes the value.

', ], ], 'SensitivityLevel' => [ 'base' => NULL, 'refs' => [ 'SqliMatchStatement$SensitivityLevel' => '

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide.

LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.

Default: LOW

', ], ], 'SingleCookieName' => [ 'base' => NULL, 'refs' => [ 'CookieNames$member' => NULL, ], ], 'SingleHeader' => [ 'base' => '

Inspect one of the headers in the web request, identified by name, for example, User-Agent or Referer. The name isn\'t case sensitive.

You can filter and inspect all headers with the FieldToMatch setting Headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "SingleHeader": { "Name": "haystack" }

', 'refs' => [ 'FieldToMatch$SingleHeader' => '

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn\'t case sensitive.

Example JSON: "SingleHeader": { "Name": "haystack" }

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

', ], ], 'SingleQueryArgument' => [ 'base' => '

Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion. The name isn\'t case sensitive.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

', 'refs' => [ 'FieldToMatch$SingleQueryArgument' => '

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn\'t case sensitive.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

', ], ], 'Size' => [ 'base' => NULL, 'refs' => [ 'SizeConstraintStatement$Size' => '

The size, in byte, to compare to the request part, after any transformations.

', ], ], 'SizeConstraintStatement' => [ 'base' => '

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

', 'refs' => [ 'Statement$SizeConstraintStatement' => '

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

', ], ], 'SizeInspectionLimit' => [ 'base' => NULL, 'refs' => [ 'RequestBodyAssociatedResourceTypeConfig$DefaultSizeInspectionLimit' => '

Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.

Default: 16 KB (16,384 bytes)

', ], ], 'SolveTimestamp' => [ 'base' => NULL, 'refs' => [ 'CaptchaResponse$SolveTimestamp' => '

The time that the CAPTCHA was last solved for the supplied token.

', 'ChallengeResponse$SolveTimestamp' => '

The time that the challenge was last solved for the supplied token.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'WAFLimitsExceededException$SourceType' => '

Source type for the exception.

', ], ], 'SqliMatchStatement' => [ 'base' => '

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

', 'refs' => [ 'Statement$SqliMatchStatement' => '

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

', ], ], 'Statement' => [ 'base' => '

The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.

For example specifications, see the examples section of CreateWebACL.

', 'refs' => [ 'ManagedRuleGroupStatement$ScopeDownStatement' => '

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

', 'NotStatement$Statement' => '

The statement to negate. You can use any statement that can be nested.

', 'RateBasedStatement$ScopeDownStatement' => '

An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

', 'Rule$Statement' => '

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

', 'Statements$member' => NULL, ], ], 'Statements' => [ 'base' => NULL, 'refs' => [ 'AndStatement$Statements' => '

The statements to combine with AND logic. You can use any statements that can be nested.

', 'OrStatement$Statements' => '

The statements to combine with OR logic. You can use any statements that can be nested.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AWSManagedRulesATPRuleSet$LoginPath' => '

The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn\'t match the login path /home/web/login or /website/login.

The rule group inspects only HTTP POST requests to your specified login endpoint.

', ], ], 'SuccessCode' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionStatusCodeSuccessCodes$member' => NULL, ], ], 'SuccessValue' => [ 'base' => NULL, 'refs' => [ 'ResponseInspectionBodyContainsSuccessStrings$member' => NULL, 'ResponseInspectionHeaderSuccessValues$member' => NULL, 'ResponseInspectionJsonSuccessValues$member' => NULL, ], ], 'Tag' => [ 'base' => '

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagInfoForResource' => [ 'base' => '

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can\'t manage or view tags through the WAF console.

', 'refs' => [ 'ListTagsForResourceResponse$TagInfoForResource' => '

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

An array of keys identifying the tags to disassociate from the resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateIPSetRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateRegexPatternSetRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateRuleGroupRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'CreateWebACLRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', 'MobileSdkRelease$Tags' => '

Tags that are associated with the release.

', 'TagInfoForResource$TagList' => '

The array of Tag objects defined for the resource.

', 'TagResourceRequest$Tags' => '

An array of key:value pairs to associate with the resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

', ], ], 'TextTransformation' => [ 'base' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

', 'refs' => [ 'TextTransformations$member' => NULL, ], ], 'TextTransformationPriority' => [ 'base' => NULL, 'refs' => [ 'TextTransformation$Priority' => '

Sets the relative processing order for multiple transformations. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don\'t need to be consecutive, but they must all be different.

', ], ], 'TextTransformationType' => [ 'base' => NULL, 'refs' => [ 'TextTransformation$Type' => '

For detailed descriptions of each of the transformation types, see Text transformations in the WAF Developer Guide.

', ], ], 'TextTransformations' => [ 'base' => NULL, 'refs' => [ 'ByteMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitCookie$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitHeader$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitQueryArgument$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitQueryString$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RateLimitUriPath$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RegexMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'RegexPatternSetReferenceStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'SizeConstraintStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'SqliMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', 'XssMatchStatement$TextTransformations' => '

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they\'re used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

', ], ], 'TimeWindow' => [ 'base' => '

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request.

', 'refs' => [ 'GetSampledRequestsRequest$TimeWindow' => '

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that\'s earlier than three hours ago, WAF sets it to three hours ago.

', 'GetSampledRequestsResponse$TimeWindow' => '

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

', ], ], 'TimeWindowDay' => [ 'base' => NULL, 'refs' => [ 'ManagedRuleSetVersion$ForecastedLifetime' => '

The amount of time you expect this version of your managed rule group to last, in days.

', 'VersionToPublish$ForecastedLifetime' => '

The amount of time the vendor expects this version of the managed rule group to last, in days.

', ], ], 'TimeWindowSecond' => [ 'base' => NULL, 'refs' => [ 'ImmunityTimeProperty$ImmunityTime' => '

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default setting is 300.

For the Challenge action, the minimum setting is 300.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$CreationTimestamp' => '

The date and time that the key was created.

', 'GetDecryptedAPIKeyResponse$CreationTimestamp' => '

The date and time that the key was created.

', 'ManagedRuleGroupVersion$LastUpdateTimestamp' => '

The date and time that the managed rule group owner updated the rule group version information.

', 'ManagedRuleSetVersion$PublishTimestamp' => '

The time that you first published this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'ManagedRuleSetVersion$LastUpdateTimestamp' => '

The last time that you updated this version.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'ManagedRuleSetVersion$ExpiryTimestamp' => '

The time that this version is set to expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'MobileSdkRelease$Timestamp' => '

The timestamp of the release.

', 'ReleaseSummary$Timestamp' => '

The timestamp of the release.

', 'SampledHTTPRequest$Timestamp' => '

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

', 'TimeWindow$StartTime' => '

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

', 'TimeWindow$EndTime' => '

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$ExpiryTimestamp' => '

The time that you want the version to expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', 'UpdateManagedRuleSetVersionExpiryDateResponse$ExpiryTimestamp' => '

The time that the version will expire.

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

', ], ], 'TokenDomain' => [ 'base' => NULL, 'refs' => [ 'APIKeyTokenDomains$member' => NULL, 'TokenDomains$member' => NULL, ], ], 'TokenDomains' => [ 'base' => NULL, 'refs' => [ 'APIKeySummary$TokenDomains' => '

The token domains that are defined in this API key.

', 'CreateWebACLRequest$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', 'GetDecryptedAPIKeyResponse$TokenDomains' => '

The token domains that are defined in this API key.

', 'UpdateWebACLRequest$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren\'t allowed. For example, you can\'t use gov.au or co.uk as token domains.

', 'WebACL$TokenDomains' => '

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don\'t specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource\'s host domain plus all domains in the token domain list, including their prefixed subdomains.

', ], ], 'URIString' => [ 'base' => NULL, 'refs' => [ 'HTTPRequest$URI' => '

The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIPSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIPSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateManagedRuleSetVersionExpiryDateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateManagedRuleSetVersionExpiryDateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRegexPatternSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRegexPatternSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebACLRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebACLResponse' => [ 'base' => NULL, 'refs' => [], ], 'UriPath' => [ 'base' => '

Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg.

This is used in the FieldToMatch specification for some web request component types.

JSON specification: "UriPath": {}

', 'refs' => [ 'FieldToMatch$UriPath' => '

Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

', ], ], 'UsernameField' => [ 'base' => '

The name of the field in the request payload that contains your customer\'s username.

This data type is used in the RequestInspection and RequestInspectionACFP data types.

', 'refs' => [ 'ManagedRuleGroupConfig$UsernameField' => '

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

', 'RequestInspection$UsernameField' => '

The name of the field in the request payload that contains your customer\'s username.

How you specify this depends on the request inspection payload type.

', 'RequestInspectionACFP$UsernameField' => '

The name of the field in the request payload that contains your customer\'s username.

How you specify this depends on the request inspection payload type.

', ], ], 'VendorName' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedProductsByVendorRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'DescribeManagedRuleGroupRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ListAvailableManagedRuleGroupVersionsRequest$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedProductDescriptor$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedRuleGroupStatement$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', 'ManagedRuleGroupSummary$VendorName' => '

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

', ], ], 'VersionKeyString' => [ 'base' => NULL, 'refs' => [ 'DescribeManagedRuleGroupRequest$VersionName' => '

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don\'t provide this, WAF uses the vendor\'s default version.

', 'DescribeManagedRuleGroupResponse$VersionName' => '

The managed rule group\'s version.

', 'GenerateMobileSdkReleaseUrlRequest$ReleaseVersion' => '

The release version. For the latest available version, specify LATEST.

', 'GetMobileSdkReleaseRequest$ReleaseVersion' => '

The release version. For the latest available version, specify LATEST.

', 'ListAvailableManagedRuleGroupVersionsResponse$CurrentDefaultVersion' => '

The name of the version that\'s currently set as the default.

', 'ManagedRuleGroupStatement$Version' => '

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don\'t specify this, WAF uses the vendor\'s default version, and then keeps the version at the vendor\'s default when the vendor updates the managed rule group settings.

', 'ManagedRuleGroupVersion$Name' => '

The version name.

', 'ManagedRuleSet$RecommendedVersion' => '

The version that you would like your customers to use.

', 'MobileSdkRelease$ReleaseVersion' => '

The release version.

', 'PublishedVersions$key' => NULL, 'PutManagedRuleSetVersionsRequest$RecommendedVersion' => '

The version of the named managed rule group that you\'d like your customers to choose, from among your version offerings.

', 'ReleaseSummary$ReleaseVersion' => '

The release version.

', 'UpdateManagedRuleSetVersionExpiryDateRequest$VersionToExpire' => '

The version that you want to remove from your list of offerings for the named managed rule group.

', 'UpdateManagedRuleSetVersionExpiryDateResponse$ExpiringVersion' => '

The version that is set to expire.

', 'VersionsToPublish$key' => NULL, ], ], 'VersionToPublish' => [ 'base' => '

A version of the named managed rule group, that the rule group\'s vendor publishes for use by customers.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

', 'refs' => [ 'VersionsToPublish$value' => NULL, ], ], 'VersionsToPublish' => [ 'base' => NULL, 'refs' => [ 'PutManagedRuleSetVersionsRequest$VersionsToPublish' => '

The versions of the named managed rule group that you want to offer to your customers.

', ], ], 'VisibilityConfig' => [ 'base' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'refs' => [ 'CreateRuleGroupRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'CreateWebACLRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'FirewallManagerRuleGroup$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'Rule$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

If you change the name of a Rule after you create it and you want the rule\'s metric name to reflect the change, update the metric name as well. WAF doesn\'t automatically update the metric name.

', 'RuleGroup$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'UpdateRuleGroupRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'UpdateWebACLRequest$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', 'WebACL$VisibilityConfig' => '

Defines and enables Amazon CloudWatch metrics and web request sample collection.

', ], ], 'WAFAssociatedItemException' => [ 'base' => '

WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

', 'refs' => [], ], 'WAFConfigurationWarningException' => [ 'base' => '

The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

Provide the handling configuration and retry your operation.

Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true).

', 'refs' => [], ], 'WAFDuplicateItemException' => [ 'base' => '

WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

', 'refs' => [], ], 'WAFExpiredManagedRuleGroupVersionException' => [ 'base' => '

The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.

', 'refs' => [], ], 'WAFInternalErrorException' => [ 'base' => '

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

', 'refs' => [], ], 'WAFInvalidOperationException' => [ 'base' => '

The operation isn\'t valid.

', 'refs' => [], ], 'WAFInvalidParameterException' => [ 'base' => '

The operation failed because WAF didn\'t recognize a parameter in the request. For example:

', 'refs' => [], ], 'WAFInvalidPermissionPolicyException' => [ 'base' => '

The operation failed because the specified policy isn\'t in the proper format.

The policy specifications must conform to the following:

For more information, see IAM Policies.

', 'refs' => [], ], 'WAFInvalidResourceException' => [ 'base' => '

WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

', 'refs' => [], ], 'WAFLimitsExceededException' => [ 'base' => '

WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

', 'refs' => [], ], 'WAFLogDestinationPermissionIssueException' => [ 'base' => '

The operation failed because you don\'t have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the WAF Developer Guide.

', 'refs' => [], ], 'WAFNonexistentItemException' => [ 'base' => '

WAF couldn’t perform the operation because your resource doesn\'t exist. If you\'ve just created a resource that you\'re using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

', 'refs' => [], ], 'WAFOptimisticLockException' => [ 'base' => '

WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

', 'refs' => [], ], 'WAFServiceLinkedRoleErrorException' => [ 'base' => '

WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

', 'refs' => [], ], 'WAFSubscriptionNotFoundException' => [ 'base' => '

You tried to use a managed rule group that\'s available by subscription, but you aren\'t subscribed to it yet.

', 'refs' => [], ], 'WAFTagOperationException' => [ 'base' => '

An error occurred during the tagging operation. Retry your request.

', 'refs' => [], ], 'WAFTagOperationInternalErrorException' => [ 'base' => '

WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

', 'refs' => [], ], 'WAFUnavailableEntityException' => [ 'base' => '

WAF couldn’t retrieve a resource that you specified for this operation. If you\'ve just created a resource that you\'re using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.

', 'refs' => [], ], 'WAFUnsupportedAggregateKeyTypeException' => [ 'base' => '

The rule that you\'ve named doesn\'t aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

', 'refs' => [], ], 'WebACL' => [ 'base' => '

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

', 'refs' => [ 'GetWebACLForResourceResponse$WebACL' => '

The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.

', 'GetWebACLResponse$WebACL' => '

The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

', ], ], 'WebACLSummaries' => [ 'base' => NULL, 'refs' => [ 'ListWebACLsResponse$WebACLs' => '

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

', ], ], 'WebACLSummary' => [ 'base' => '

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

', 'refs' => [ 'CreateWebACLResponse$Summary' => '

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

', 'WebACLSummaries$member' => NULL, ], ], 'XssMatchStatement' => [ 'base' => '

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

', 'refs' => [ 'Statement$XssMatchStatement' => '

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

', ], ], ],];